@datafire/google_cloudidentity

Client library for Cloud Identity API

Installation and Usage

npm install --save @datafire/google_cloudidentity

let google_cloudidentity = require('@datafire/google_cloudidentity').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

API for provisioning and managing identity resources.

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

google_cloudidentity.oauthCallback({
  "code": ""
}, context)

Input

• input object
  • code required string

Output

• output object
  • access_token string
  • refresh_token string
  • token_type string
  • scope string
  • expiration string

oauthRefresh

Exchange a refresh_token for an access_token

google_cloudidentity.oauthRefresh(null, context)

Input

This action has no parameters

Output

• output object
  • access_token string
  • refresh_token string
  • token_type string
  • scope string
  • expiration string

cloudidentity.devices.list

Lists/Searches devices.

google_cloudidentity.cloudidentity.devices.list({}, context)

Input

• input object
  • customer string: Required. Resource name of the customer.
  • filter string: Optional. Additional restrictions when fetching list of devices. For a list of search fields, refer to Mobile device search fields. Multiple search fields are separated by the space character.
  • orderBy string: Optional. Order specification for devices in the response. Only one of the following field names may be used to specify the order: create_time, last_sync_time, model, os_version, device_type and serial_number. desc may be specified optionally to specify results to be sorted in descending order. Default order is ascending.
  • pageSize integer: Optional. The maximum number of Devices to return. If unspecified, at most 20 Devices will be returned. The maximum value is 100; values above 100 will be coerced to 100.
  • pageToken string: Optional. A page token, received from a previous ListDevices call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDevices must match the call that provided the page token.
  • view string (values: VIEW_UNSPECIFIED, COMPANY_INVENTORY, USER_ASSIGNED_DEVICES): Optional. The view to use for the List request.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output ListDevicesResponse

cloudidentity.devices.create

Creates a device. Only company-owned device may be created. Note: This method is available only to customers who have one of the following SKUs: Enterprise Standard, Enterprise Plus, Enterprise for Education, and Cloud Identity Premium

google_cloudidentity.cloudidentity.devices.create({}, context)

Input

• input object
  • body CreateDeviceRequest
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Operation

cloudidentity.groups.list

Lists the Groups under a customer or namespace.

google_cloudidentity.cloudidentity.groups.list({}, context)

Input

• input object
  • pageSize integer: The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a next_page_token. If unspecified, defaults to 200 for View.BASIC and to 50 for View.FULL. Must not be greater than 1000 for View.BASIC or 500 for View.FULL.
  • pageToken string: The next_page_token value returned from a previous list request, if any.
  • parent string: Required. The parent resource under which to list all Groups. Must be of the form identitysources/{identity_source_id} for external- identity-mapped groups or customers/{customer_id} for Google Groups.
  • view string (values: VIEW_UNSPECIFIED, BASIC, FULL): The level of detail to be returned. If unspecified, defaults to View.BASIC.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output ListGroupsResponse

cloudidentity.groups.create

Creates a Group.

google_cloudidentity.cloudidentity.groups.create({}, context)

Input

• input object
  • initialGroupConfig string (values: INITIAL_GROUP_CONFIG_UNSPECIFIED, WITH_INITIAL_OWNER, EMPTY): Required. The initial configuration option for the Group.
  • body Group
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Operation

cloudidentity.groups.lookup

Looks up the resource name of a Group by its EntityKey.

google_cloudidentity.cloudidentity.groups.lookup({}, context)

Input

• input object
  • groupKey.id string: The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source's requirements. Must be unique within a namespace.
  • groupKey.namespace string: The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output LookupGroupNameResponse

cloudidentity.groups.search

Searches for Groups matching a specified query.

google_cloudidentity.cloudidentity.groups.search({}, context)

Input

• input object
  • pageSize integer: The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a next_page_token. If unspecified, defaults to 200 for GroupView.BASIC and to 50 for GroupView.FULL. Must not be greater than 1000 for GroupView.BASIC or 500 for GroupView.FULL.
  • pageToken string: The next_page_token value returned from a previous search request, if any.
  • query string: Required. The search query. Must be specified in Common Expression Language. May only contain equality operators on the parent and inclusion operators on labels (e.g., parent == 'customers/{customer_id}' && 'cloudidentity.googleapis.com/groups.discussion_forum' in labels).
  • view string (values: BASIC, FULL): The level of detail to be returned. If unspecified, defaults to View.BASIC.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output SearchGroupsResponse

cloudidentity.groups.memberships.delete

Deletes a Membership.

google_cloudidentity.cloudidentity.groups.memberships.delete({
  "name": ""
}, context)

Input

• input object
  • name required string: Required. The resource name of the Membership to delete. Must be of the form groups/{group_id}/memberships/{membership_id}.
  • customer string: Required. Resource name of the customer. If you're using this API for your own organization, use customers/my_customer If you're using this API to manage another organization, use customers/{customer_id}, where customer_id is the customer to whom the device belongs.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Operation

cloudidentity.groups.memberships.get

Retrieves a Membership.

google_cloudidentity.cloudidentity.groups.memberships.get({
  "name": ""
}, context)

Input

• input object
  • name required string: Required. The resource name of the Membership to retrieve. Must be of the form groups/{group_id}/memberships/{membership_id}.
  • customer string: Required. Resource name of the customer. If you're using this API for your own organization, use customers/my_customer If you're using this API to manage another organization, use customers/{customer_id}, where customer_id is the customer to whom the device belongs.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Membership

cloudidentity.groups.patch

Updates a Group.

google_cloudidentity.cloudidentity.groups.patch({
  "name": ""
}, context)

Input

• input object
  • name required string: Output only. The resource name of the Group. Shall be of the form groups/{group_id}.
  • updateMask string: Required. The fully-qualified names of fields to update. May only contain the following fields: display_name, description.
  • body Group
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Operation

cloudidentity.devices.deviceUsers.approve

Approves device to access user data.

google_cloudidentity.cloudidentity.devices.deviceUsers.approve({
  "name": ""
}, context)

Input

• input object
  • name required string: Required. Resource name of the Device in format: devices/{device_id}/deviceUsers/{device_user_id}, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.
  • body ApproveDeviceUserRequest
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Operation

cloudidentity.devices.deviceUsers.block

Blocks device from accessing user data

google_cloudidentity.cloudidentity.devices.deviceUsers.block({
  "name": ""
}, context)

Input

• input object
  • name required string: Required. Resource name of the Device in format: devices/{device_id}/deviceUsers/{device_user_id}, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.
  • body BlockDeviceUserRequest
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Operation

cloudidentity.devices.deviceUsers.cancelWipe

Cancels an unfinished user account wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped.

google_cloudidentity.cloudidentity.devices.deviceUsers.cancelWipe({
  "name": ""
}, context)

Input

• input object
  • name required string: Required. Resource name of the Device in format: devices/{device_id}/deviceUsers/{device_user_id}, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.
  • body CancelWipeDeviceUserRequest
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Operation

cloudidentity.groups.memberships.modifyMembershipRoles

Modifies the MembershipRoles of a Membership.

google_cloudidentity.cloudidentity.groups.memberships.modifyMembershipRoles({
  "name": ""
}, context)

Input

• input object
  • name required string: Required. The resource name of the Membership whose roles are to be modified. Must be of the form groups/{group_id}/memberships/{membership_id}.
  • body ModifyMembershipRolesRequest
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output ModifyMembershipRolesResponse

cloudidentity.devices.deviceUsers.wipe

Wipes the user's account on a device.

google_cloudidentity.cloudidentity.devices.deviceUsers.wipe({
  "name": ""
}, context)

Input

• input object
  • name required string: Required. Resource name of the Device in format: devices/{device_id}/deviceUsers/{device_user_id}, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.
  • body WipeDeviceUserRequest
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Operation

cloudidentity.devices.deviceUsers.list

Lists/Searches DeviceUsers.

google_cloudidentity.cloudidentity.devices.deviceUsers.list({
  "parent": ""
}, context)

Input

• input object
  • parent required string: Required. To list all DeviceUsers, set this to "devices/-". To list all DeviceUsers owned by a device, set this to the resource name of the device. Format: devices/{device}
  • customer string: Required. Resource name of the customer. If you're using this API for your own organization, use customers/my_customer If you're using this API to manage another organization, use customers/{customer_id}, where customer_id is the customer to whom the device belongs.
  • filter string: Optional. Additional restrictions when fetching list of devices. For a list of search fields, refer to Mobile device search fields. Multiple search fields are separated by the space character.
  • orderBy string: Optional. Order specification for devices in the response.
  • pageSize integer: Optional. The maximum number of DeviceUsers to return. If unspecified, at most 5 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20.
  • pageToken string: Optional. A page token, received from a previous ListDeviceUsers call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBooks must match the call that provided the page token.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output ListDeviceUsersResponse

cloudidentity.groups.memberships.list

Lists the Memberships within a Group.

google_cloudidentity.cloudidentity.groups.memberships.list({
  "parent": ""
}, context)

Input

• input object
  • parent required string: Required. The parent Group resource under which to lookup the Membership name. Must be of the form groups/{group_id}.
  • pageSize integer: The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a next_page_token. If unspecified, defaults to 200 for GroupView.BASIC and to 50 for GroupView.FULL. Must not be greater than 1000 for GroupView.BASIC or 500 for GroupView.FULL.
  • pageToken string: The next_page_token value returned from a previous search request, if any.
  • view string (values: BASIC, FULL): The level of detail to be returned. If unspecified, defaults to MembershipView.BASIC.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output ListMembershipsResponse

cloudidentity.groups.memberships.create

Creates a Membership.

google_cloudidentity.cloudidentity.groups.memberships.create({
  "parent": ""
}, context)

Input

• input object
  • parent required string: Required. The parent Group resource under which to create the Membership. Must be of the form groups/{group_id}.
  • body Membership
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Operation

cloudidentity.groups.memberships.checkTransitiveMembership

Check a potential member for membership in a group. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. A member has membership to a group as long as there is a single viewable transitive membership between the group and the member. The actor must have view permissions to at least one transitive membership between the member and group.

google_cloudidentity.cloudidentity.groups.memberships.checkTransitiveMembership({
  "parent": ""
}, context)

Input

• input object
  • parent required string: Resource name of the group to check the transitive membership in. Format: groups/{group_id}, where group_id is the unique id assigned to the Group to which the Membership belongs to.
  • query string: Required. A CEL expression that MUST include member specification. This is a required field. Certain groups are uniquely identified by both a 'member_key_id' and a 'member_key_namespace', which requires an additional query input: 'member_key_namespace'. Example query: member_key_id == 'member_key_id_value'
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output CheckTransitiveMembershipResponse

cloudidentity.groups.memberships.getMembershipGraph

Get a membership graph of just a member or both a member and a group. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. Given a member, the response will contain all membership paths from the member. Given both a group and a member, the response will contain all membership paths between the group and the member.

google_cloudidentity.cloudidentity.groups.memberships.getMembershipGraph({
  "parent": ""
}, context)

Input

• input object
  • parent required string: Required. Resource name of the group to search transitive memberships in. Format: groups/{group_id}, where group_id is the unique ID assigned to the Group to which the Membership belongs to. group_id can be a wildcard collection id "-". When a group_id is specified, the membership graph will be constrained to paths between the member (defined in the query) and the parent. If a wildcard collection is provided, all membership paths connected to the member will be returned.
  • query string: Required. A CEL expression that MUST include member specification AND label(s). Certain groups are uniquely identified by both a 'member_key_id' and a 'member_key_namespace', which requires an additional query input: 'member_key_namespace'. Example query: member_key_id == 'member_key_id_value' && in labels
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Operation

cloudidentity.groups.memberships.lookup

Looks up the resource name of a Membership by its EntityKey.

google_cloudidentity.cloudidentity.groups.memberships.lookup({
  "parent": ""
}, context)

Input

• input object
  • parent required string: Required. The parent Group resource under which to lookup the Membership name. Must be of the form groups/{group_id}.
  • memberKey.id string: The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source's requirements. Must be unique within a namespace.
  • memberKey.namespace string: The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output LookupMembershipNameResponse

cloudidentity.groups.memberships.searchTransitiveGroups

Search transitive groups of a member. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. A transitive group is any group that has a direct or indirect membership to the member. Actor must have view permissions all transitive groups.

google_cloudidentity.cloudidentity.groups.memberships.searchTransitiveGroups({
  "parent": ""
}, context)

Input

• input object
  • parent required string: Resource name of the group to search transitive memberships in. Format: groups/{group_id}, where group_id is always '-' as this API will search across all groups for a given member.
  • pageSize integer: The default page size is 200 (max 1000).
  • pageToken string: The next_page_token value returned from a previous list request, if any.
  • query string: Required. A CEL expression that MUST include member specification AND label(s). This is a required field. Users can search on label attributes of groups. CONTAINS match ('in') is supported on labels. Certain groups are uniquely identified by both a 'member_key_id' and a 'member_key_namespace', which requires an additional query input: 'member_key_namespace'. Example query: member_key_id == 'member_key_id_value' && in labels
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output SearchTransitiveGroupsResponse

cloudidentity.groups.memberships.searchTransitiveMemberships

Search transitive memberships of a group. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. A transitive membership is any direct or indirect membership of a group. Actor must have view permissions to all transitive memberships.

google_cloudidentity.cloudidentity.groups.memberships.searchTransitiveMemberships({
  "parent": ""
}, context)

Input

• input object
  • parent required string: Resource name of the group to search transitive memberships in. Format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
  • pageSize integer: The default page size is 200 (max 1000).
  • pageToken string: The next_page_token value returned from a previous list request, if any.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output SearchTransitiveMembershipsResponse

cloudidentity.devices.deviceUsers.lookup

Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: No properties need to be passed, the caller's credentials are sufficient to identify the corresponding DeviceUser. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.

google_cloudidentity.cloudidentity.devices.deviceUsers.lookup({
  "parent": ""
}, context)

Input

• input object
  • parent required string: Must be set to "devices/-/deviceUsers" to search across all DeviceUser belonging to the user.
  • androidId string: Android Id returned by Settings.Secure#ANDROID_ID.
  • pageSize integer: The maximum number of DeviceUsers to return. If unspecified, at most 20 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20.
  • pageToken string: A page token, received from a previous LookupDeviceUsers call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to LookupDeviceUsers must match the call that provided the page token.
  • rawResourceId string: Raw Resource Id used by Google Endpoint Verification. If the user is enrolled into Google Endpoint Verification, this id will be saved as the 'device_resource_id' field in the following platform dependent files. Mac: ~/.secureConnect/context_aware_config.json Windows: C:\Users%USERPROFILE%.secureConnect\context_aware_config.json Linux: ~/.secureConnect/context_aware_config.json
  • userId string: The user whose DeviceUser's resource name will be fetched. Must be set to 'me' to fetch the DeviceUser's resource name for the calling user.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output LookupSelfDeviceUsersResponse

Definitions

AndroidAttributes

• AndroidAttributes object: Resource representing the Android specific attributes of a Device.
  • enabledUnknownSources boolean: Whether applications from unknown sources can be installed on device.
  • ownerProfileAccount boolean: Whether this account is on an owner/primary profile. For phones, only true for owner profiles. Android 4+ devices can have secondary or restricted user profiles.
  • ownershipPrivilege string (values: OWNERSHIP_PRIVILEGE_UNSPECIFIED, DEVICE_ADMINISTRATOR, PROFILE_OWNER, DEVICE_OWNER): Ownership privileges on device.
  • supportsWorkProfile boolean: Whether device supports Android work profiles. If false, this service will not block access to corp data even if an administrator turns on the "Enforce Work Profile" policy.

ApproveDeviceUserRequest

• ApproveDeviceUserRequest object: Request message for approving the device to access user data.
  • customer string: Required. Resource name of the customer. If you're using this API for your own organization, use customers/my_customer If you're using this API to manage another organization, use customers/{customer_id}, where customer_id is the customer to whom the device belongs.

ApproveDeviceUserResponse

• ApproveDeviceUserResponse object: Response message for approving the device to access user data.
  • deviceUser DeviceUser

BlockDeviceUserRequest

• BlockDeviceUserRequest object: Request message for blocking account on device.
  • customer string: Required. Resource name of the customer. If you're using this API for your own organization, use customers/my_customer If you're using this API to manage another organization, use customers/{customer_id}, where customer_id is the customer to whom the device belongs.

BlockDeviceUserResponse

• BlockDeviceUserResponse object: Response message for blocking the device from accessing user data.
  • deviceUser DeviceUser

CancelWipeDeviceRequest

• CancelWipeDeviceRequest object: Request message for cancelling an unfinished device wipe.
  • customer string: Required. Resource name of the customer. If you're using this API for your own organization, use customers/my_customer If you're using this API to manage another organization, use customers/{customer_id}, where customer_id is the customer to whom the device belongs.

CancelWipeDeviceResponse

• CancelWipeDeviceResponse object: Response message for cancelling an unfinished device wipe.
  • device Device

CancelWipeDeviceUserRequest

• CancelWipeDeviceUserRequest object: Request message for cancelling an unfinished user account wipe.
  • customer string: Required. Resource name of the customer. If you're using this API for your own organization, use customers/my_customer If you're using this API to manage another organization, use customers/{customer_id}, where customer_id is the customer to whom the device belongs.

CancelWipeDeviceUserResponse

• CancelWipeDeviceUserResponse object: Response message for cancelling an unfinished user account wipe.
  • deviceUser DeviceUser

CheckTransitiveMembershipResponse

• CheckTransitiveMembershipResponse object: The response message for MembershipsService.CheckTransitiveMembership.
  • hasMembership boolean: Response does not include the possible roles of a member since the behavior of this rpc is not all-or-nothing unlike the other rpcs. So, it may not be possible to list all the roles definitively, due to possible lack of authorization in some of the paths.

ClientState

• ClientState object: Represents the state associated with an API client calling the Devices API. Resource representing ClientState and supports updates from API users
  • assetTags array: The caller can specify asset tags for this resource
    • items string
  • complianceState string (values: COMPLIANCE_STATE_UNSPECIFIED, COMPLIANT, NON_COMPLIANT): The compliance state of the resource as specified by the API client.
  • createTime string: Output only. The time the client state data was created.
  • customId string: This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field.
  • etag string: The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest
  • healthScore string (values: HEALTH_SCORE_UNSPECIFIED, VERY_POOR, POOR, NEUTRAL, GOOD, VERY_GOOD): The Health score of the resource
  • keyValuePairs object: The map of key-value attributes stored by callers specific to a device. The total serialized length of this map may not exceed 10KB. No limit is placed on the number of attributes in a map.
  • lastUpdateTime string: Output only. The time the client state data was last updated.
  • managed string (values: MANAGED_STATE_UNSPECIFIED, MANAGED, UNMANAGED): The management state of the resource as specified by the API client.
  • name string: Output only. Resource name of the ClientState in format: devices/{device_id}/deviceUsers/{device_user_id}/clientState/{partner_id}, where partner_id corresponds to the partner storing the data.
  • ownerType string (values: OWNER_TYPE_UNSPECIFIED, OWNER_TYPE_CUSTOMER, OWNER_TYPE_PARTNER): Output only. The owner of the ClientState
  • scoreReason string: A descriptive cause of the health score.

CreateDeviceRequest

• CreateDeviceRequest object: Request message for creating a Company Owned device.
  • customer string: Required. Resource name of the customer. If you're using this API for your own organization, use customers/my_customer If you're using this API to manage another organization, use customers/{customer_id}, where customer_id is the customer to whom the device belongs.
  • device Device

CustomAttributeValue

• CustomAttributeValue object: Additional custom attribute values may be one of these types
  • boolValue boolean: Represents a boolean value.
  • numberValue number: Represents a double value.
  • stringValue string: Represents a string value.

Device

• Device object: A Device within the Cloud Identity Devices API. Represents a Device known to Google Cloud, independent of the device ownership, type, and whether it is assigned or in use by a user.
  • androidSpecificAttributes AndroidAttributes
  • assetTag string: Asset tag of the device.
  • basebandVersion string: Output only. Baseband version of the device.
  • bootloaderVersion string: Output only. Device bootloader version. Example: 0.6.7.
  • brand string: Output only. Device brand. Example: Samsung.
  • buildNumber string: Output only. Build number of the device.
  • compromisedState string (values: COMPROMISED_STATE_UNSPECIFIED, COMPROMISED, UNCOMPROMISED): Output only. Represents whether the Device is compromised.
  • createTime string: Output only. When the Company-Owned device was imported. This field is empty for BYOD devices.
  • deviceType string (values: DEVICE_TYPE_UNSPECIFIED, ANDROID, IOS, GOOGLE_SYNC, WINDOWS, MAC_OS, LINUX, CHROME_OS): Output only. Type of device.
  • enabledDeveloperOptions boolean: Output only. Whether developer options is enabled on device.
  • enabledUsbDebugging boolean: Output only. Whether USB debugging is enabled on device.
  • encryptionState string (values: ENCRYPTION_STATE_UNSPECIFIED, UNSUPPORTED_BY_DEVICE, ENCRYPTED, NOT_ENCRYPTED): Output only. Device encryption state.
  • imei string: Output only. IMEI number of device if GSM device; empty otherwise.
  • kernelVersion string: Output only. Kernel version of the device.
  • lastSyncTime string: Most recent time when device synced with this service.
  • managementState string (values: MANAGEMENT_STATE_UNSPECIFIED, APPROVED, BLOCKED, PENDING, UNPROVISIONED, WIPING, WIPED): Output only. Management state of the device
  • manufacturer string: Output only. Device manufacturer. Example: Motorola.
  • meid string: Output only. MEID number of device if CDMA device; empty otherwise.
  • model string: Output only. Model name of device. Example: Pixel 3.
  • name string: Output only. Resource name of the Device in format: devices/{device_id}, where device_id is the unique id assigned to the Device.
  • networkOperator string: Output only. Mobile or network operator of device, if available.
  • osVersion string: Output only. OS version of the device. Example: Android 8.1.0.
  • otherAccounts array: Output only. Domain name for Google accounts on device. Type for other accounts on device. On Android, will only be populated if |ownership_privilege| is |PROFILE_OWNER| or |DEVICE_OWNER|. Does not include the account signed in to the device policy app if that account's domain has only one account. Examples: "com.example", "xyz.com".
    • items string
  • ownerType string (values: DEVICE_OWNERSHIP_UNSPECIFIED, COMPANY, BYOD): Output only. Whether the device is owned by the company or an individual
  • releaseVersion string: Output only. OS release version. Example: 6.0.
  • securityPatchTime string: Output only. OS security patch update time on device.
  • serialNumber string: Serial Number of device. Example: HT82V1A01076.
  • wifiMacAddresses array: WiFi MAC addresses of device.
    • items string

DeviceUser

• DeviceUser object: Represents a user's use of a Device in the Cloud Identity Devices API. A DeviceUser is a resource representing a user's use of a Device
  • compromisedState string (values: COMPROMISED_STATE_UNSPECIFIED, COMPROMISED, NOT_COMPROMISED): Compromised State of the DeviceUser object
  • createTime string: When the user first signed in to the device
  • firstSyncTime string: Output only. Most recent time when user registered with this service.
  • languageCode string: Output only. Default locale used on device, in IETF BCP-47 format.
  • lastSyncTime string: Output only. Last time when user synced with policies.
  • managementState string (values: MANAGEMENT_STATE_UNSPECIFIED, WIPING, WIPED, APPROVED, BLOCKED, PENDING_APPROVAL, UNENROLLED): Output only. Management state of the user on the device.
  • name string: Output only. Resource name of the DeviceUser in format: devices/{device_id}/deviceUsers/{user_id}, where user_id is the ID of the user associated with the user session.
  • passwordState string (values: PASSWORD_STATE_UNSPECIFIED, PASSWORD_SET, PASSWORD_NOT_SET): Password state of the DeviceUser object
  • userAgent string: Output only. User agent on the device for this specific user
  • userEmail string: Email address of the user registered on the device.

DynamicGroupMetadata

• DynamicGroupMetadata object: Dynamic group metadata like queries and status.
  • queries array: Memberships will be the union of all queries. Only one entry with USER resource is currently supported.
    • items DynamicGroupQuery
  • status DynamicGroupStatus

DynamicGroupQuery

• DynamicGroupQuery object: Defines a query on a resource.
  • query string: Query that determines the memberships of the dynamic group. Examples: All users with at least one organizations.department of engineering. user.organizations.exists(org, org.department=='engineering') All users with at least one location that has area of foo and building_id of bar. user.locations.exists(loc, loc.area=='foo' && loc.building_id=='bar')
  • resourceType string (values: RESOURCE_TYPE_UNSPECIFIED, USER)

DynamicGroupStatus

• DynamicGroupStatus object: The current status of a dynamic group along with timestamp.
  • status string (values: STATUS_UNSPECIFIED, UP_TO_DATE, UPDATING_MEMBERSHIPS): Status of the dynamic group.
  • statusTime string: The latest time at which the dynamic group is guaranteed to be in the given status. If status is UP_TO_DATE, the latest time at which the dynamic group was confirmed to be up-to-date. If status is UPDATING_MEMBERSHIPS, the time at which dynamic group was created.

EntityKey

• EntityKey object: A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional namespace or a user without a namespace. The combination of id and namespace must be unique; however, the same id can be used with different namespaces.
  • id string: The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source's requirements. Must be unique within a namespace.
  • namespace string: The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}.

ExpiryDetail

• ExpiryDetail object: The MembershipRole expiry details.
  • expireTime string: The time at which the MembershipRole will expire.

GetMembershipGraphResponse

• GetMembershipGraphResponse object: The response message for MembershipsService.GetMembershipGraph.
  • adjacencyList array: The membership graph's path information represented as an adjacency list.
    • items MembershipAdjacencyList
  • groups array: The resources representing each group in the adjacency list. Each group in this list can be correlated to a 'group' of the MembershipAdjacencyList using the 'name' of the Group resource.
    • items Group

GoogleAppsCloudidentityDevicesV1AndroidAttributes

• GoogleAppsCloudidentityDevicesV1AndroidAttributes object: Resource representing the Android specific attributes of a Device.
  • enabledUnknownSources boolean: Whether applications from unknown sources can be installed on device.
  • ownerProfileAccount boolean: Whether this account is on an owner/primary profile. For phones, only true for owner profiles. Android 4+ devices can have secondary or restricted user profiles.
  • ownershipPrivilege string (values: OWNERSHIP_PRIVILEGE_UNSPECIFIED, DEVICE_ADMINISTRATOR, PROFILE_OWNER, DEVICE_OWNER): Ownership privileges on device.
  • supportsWorkProfile boolean: Whether device supports Android work profiles. If false, this service will not block access to corp data even if an administrator turns on the "Enforce Work Profile" policy.

GoogleAppsCloudidentityDevicesV1ApproveDeviceUserResponse

• GoogleAppsCloudidentityDevicesV1ApproveDeviceUserResponse object: Response message for approving the device to access user data.
  • deviceUser GoogleAppsCloudidentityDevicesV1DeviceUser

GoogleAppsCloudidentityDevicesV1BlockDeviceUserResponse

• GoogleAppsCloudidentityDevicesV1BlockDeviceUserResponse object: Response message for blocking the device from accessing user data.
  • deviceUser GoogleAppsCloudidentityDevicesV1DeviceUser

GoogleAppsCloudidentityDevicesV1CancelWipeDeviceResponse

• GoogleAppsCloudidentityDevicesV1CancelWipeDeviceResponse object: Response message for cancelling an unfinished device wipe.
  • device GoogleAppsCloudidentityDevicesV1Device

GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserResponse

• GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserResponse object: Response message for cancelling an unfinished user account wipe.
  • deviceUser GoogleAppsCloudidentityDevicesV1DeviceUser

GoogleAppsCloudidentityDevicesV1ClientState

• GoogleAppsCloudidentityDevicesV1ClientState object: Represents the state associated with an API client calling the Devices API. Resource representing ClientState and supports updates from API users
  • assetTags array: The caller can specify asset tags for this resource
    • items string
  • complianceState string (values: COMPLIANCE_STATE_UNSPECIFIED, COMPLIANT, NON_COMPLIANT): The compliance state of the resource as specified by the API client.
  • createTime string: Output only. The time the client state data was created.
  • customId string: This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field.
  • etag string: The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest
  • healthScore string (values: HEALTH_SCORE_UNSPECIFIED, VERY_POOR, POOR, NEUTRAL, GOOD, VERY_GOOD): The Health score of the resource. The Health score is the callers specification of the condition of the device from a usability point of view. For example, a third-party device management provider may specify a health score based on its compliance with organizational policies.
  • keyValuePairs object: The map of key-value attributes stored by callers specific to a device. The total serialized length of this map may not exceed 10KB. No limit is placed on the number of attributes in a map.
  • lastUpdateTime string: Output only. The time the client state data was last updated.
  • managed string (values: MANAGED_STATE_UNSPECIFIED, MANAGED, UNMANAGED): The management state of the resource as specified by the API client.
  • name string: Output only. Resource name of the ClientState in format: devices/{device_id}/deviceUsers/{device_user_id}/clientState/{partner_id}, where partner_id corresponds to the partner storing the data. For partners belonging to the "BeyondCorp Alliance", this is the partner ID specified to you by Google. For all other callers, this is a string of the form: {customer_id}-suffix, where customer_id is your customer ID. The suffix is any string the caller specifies. This string will be displayed verbatim in the administration console. This suffix is used in setting up Custom Access Levels in Context-Aware Access. Your organization's customer ID can be obtained from the URL: GET https://www.googleapis.com/admin/directory/v1/customers/my_customer The `id