Cloud Identity API

API for provisioning and managing identity resources.

Service: cloudidentity.googleapis.com

We recommend that you call this service using Google-provided client libraries. If your application needs to call this service using your own libraries, you should use the following information when making the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service may have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://cloudidentity.googleapis.com

REST Resource: v1beta1.devices

Methods
cancelWipe POST /v1beta1/{name=devices/*}:cancelWipe
Cancels an unfinished device wipe.
create POST /v1beta1/devices
Creates a device.
delete DELETE /v1beta1/{name=devices/*}
Deletes the specified device.
get GET /v1beta1/{name=devices/*}
Retrieves the specified device.
list GET /v1beta1/devices
Lists/Searches devices.
wipe POST /v1beta1/{name=devices/*}:wipe
Wipes all data on the specified device.

REST Resource: v1beta1.devices.deviceUsers

Methods
approve POST /v1beta1/{name=devices/*/deviceUsers/*}:approve
Approves device to access user data.
block POST /v1beta1/{name=devices/*/deviceUsers/*}:block
Blocks device from accessing user data
cancelWipe POST /v1beta1/{name=devices/*/deviceUsers/*}:cancelWipe
Cancels an unfinished user account wipe.
delete DELETE /v1beta1/{name=devices/*/deviceUsers/*}
Deletes the specified DeviceUser.
get GET /v1beta1/{name=devices/*/deviceUsers/*}
Retrieves the specified DeviceUser
list GET /v1beta1/{parent=devices/*}/deviceUsers
Lists/Searches DeviceUsers.
lookup GET /v1beta1/{parent=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.
wipe POST /v1beta1/{name=devices/*/deviceUsers/*}:wipe
Wipes the user's account on a device.

REST Resource: v1beta1.devices.deviceUsers.clientStates

Methods
get GET /v1beta1/{name=devices/*/deviceUsers/*/clientStates/*}
Gets the client state for the device user
patch PATCH /v1beta1/{clientState.name=devices/*/deviceUsers/*/clientStates/*}
Updates the client state for the device user

REST Resource: v1beta1.groups

Methods
create POST /v1beta1/groups
Creates a Group.
delete DELETE /v1beta1/{name=groups/*}
Deletes a Group.
get GET /v1beta1/{name=groups/*}
Retrieves a Group.
list GET /v1beta1/groups
Lists the Groups under a customer or namespace.
lookup GET /v1beta1/groups:lookup
Looks up the resource name of a Group by its EntityKey.
patch PATCH /v1beta1/{resource.name=groups/*}
Updates a Group.
search GET /v1beta1/groups:search
Searches for Groups matching a specified query.

REST Resource: v1beta1.groups.memberships

Methods
checkTransitiveMembership GET /v1beta1/{parent=groups/*}/memberships:checkTransitiveMembership
Check a potential member for membership in a group.
create POST /v1beta1/{parent=groups/*}/memberships
Creates a Membership.
delete DELETE /v1beta1/{name=groups/*/memberships/*}
Deletes a Membership.
get GET /v1beta1/{name=groups/*/memberships/*}
Retrieves a Membership.
getMembershipGraph GET /v1beta1/{parent=groups/*}/memberships:getMembershipGraph
Get a membership graph of just a member or both a member and a group.
list GET /v1beta1/{parent=groups/*}/memberships
Lists the Memberships within a Group.
lookup GET /v1beta1/{parent=groups/*}/memberships:lookup
Looks up the resource name of a Membership by its EntityKey.
modifyMembershipRoles POST /v1beta1/{name=groups/*/memberships/*}:modifyMembershipRoles
Modifies the MembershipRoles of a Membership.
searchTransitiveGroups GET /v1beta1/{parent=groups/*}/memberships:searchTransitiveGroups
Search transitive groups of a member.
searchTransitiveMemberships GET /v1beta1/{parent=groups/*}/memberships:searchTransitiveMemberships
Search transitive memberships of a group.

Service: cloudidentity.googleapis.com

We recommend that you call this service using Google-provided client libraries. If your application needs to call this service using your own libraries, you should use the following information when making the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service may have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://cloudidentity.googleapis.com

REST Resource: v1.devices

Methods
cancelWipe POST /v1/{name=devices/*}:cancelWipe
Cancels an unfinished device wipe.
create POST /v1/devices
Creates a device.
delete DELETE /v1/{name=devices/*}
Deletes the specified device.
get GET /v1/{name=devices/*}
Retrieves the specified device.
list GET /v1/devices
Lists/Searches devices.
wipe POST /v1/{name=devices/*}:wipe
Wipes all data on the specified device.

REST Resource: v1.devices.deviceUsers

Methods
approve POST /v1/{name=devices/*/deviceUsers/*}:approve
Approves device to access user data.
block POST /v1/{name=devices/*/deviceUsers/*}:block
Blocks device from accessing user data
cancelWipe POST /v1/{name=devices/*/deviceUsers/*}:cancelWipe
Cancels an unfinished user account wipe.
delete DELETE /v1/{name=devices/*/deviceUsers/*}
Deletes the specified DeviceUser.
get GET /v1/{name=devices/*/deviceUsers/*}
Retrieves the specified DeviceUser
list GET /v1/{parent=devices/*}/deviceUsers
Lists/Searches DeviceUsers.
lookup GET /v1/{parent=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.
wipe POST /v1/{name=devices/*/deviceUsers/*}:wipe
Wipes the user's account on a device.

REST Resource: v1.devices.deviceUsers.clientStates

Methods
get GET /v1/{name=devices/*/deviceUsers/*/clientStates/*}
Gets the client state for the device user
list GET /v1/{parent=devices/*/deviceUsers/*}/clientStates
Lists the client states for the given search query.
patch PATCH /v1/{clientState.name=devices/*/deviceUsers/*/clientStates/*}
Updates the client state for the device user

REST Resource: v1.groups

Methods
create POST /v1/groups
Creates a Group.
delete DELETE /v1/{name=groups/*}
Deletes a Group.
get GET /v1/{name=groups/*}
Retrieves a Group.
list GET /v1/groups
Lists the Groups under a customer or namespace.
lookup GET /v1/groups:lookup
Looks up the resource name of a Group by its EntityKey.
patch PATCH /v1/{resource.name=groups/*}
Updates a Group.
search GET /v1/groups:search
Searches for Groups matching a specified query.

REST Resource: v1.groups.memberships

Methods
create POST /v1/{parent=groups/*}/memberships
Creates a Membership.
delete DELETE /v1/{name=groups/*/memberships/*}
Deletes a Membership.
get GET /v1/{name=groups/*/memberships/*}
Retrieves a Membership.
list GET /v1/{parent=groups/*}/memberships
Lists the Memberships within a Group.
lookup GET /v1/{parent=groups/*}/memberships:lookup
Looks up the resource name of a Membership by its EntityKey.
modifyMembershipRoles POST /v1/{name=groups/*/memberships/*}:modifyMembershipRoles
Modifies the MembershipRoles of a Membership.