Google

Cloud Identity API

API for provisioning and managing identity resources.

Identity & security#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

API for provisioning and managing identity resources.

Endpoints 41

allowlistedDomains

  • GETLists the domains in the allowlist./v1/allowlistedDomains?filter=string&pageSize=0&pageToken=stringLists the domains in the allowlist.
  • POSTAdds a domain to the allowlist./v1/allowlistedDomainsAdds a domain to the allowlist.

policies

  • GETGet a policy./v1/:nameGet a policy.
  • DELETEDelete a policy./v1/:nameDelete a policy.
  • PATCHUpdate a policy./v1/:nameUpdate a policy.
  • GETList policies./v1/policies?filter=string&pageSize=0&pageToken=stringList policies.
  • POSTCreate a policy./v1/policiesCreate a policy.

customers.userinvitations

  • POSTCancels a UserInvitation that was already sent./v1/:name:cancelCancels a UserInvitation that was already sent.
  • GETVerifies whether a user account is eligible to receive a UserInvitation (is an unmanaged account)/v1/:name:isInvitableUserVerifies whether a user account is eligible to receive a UserInvitation (is an unmanaged account). Eligibility is based on the following criteria: * the email…
  • GETRetrieves a list of UserInvitation resources/v1/:parent/userinvitations?filter=string&orderBy=string&pageSize=0&pageToken=stringRetrieves a list of UserInvitation resources. Note: New consumer accounts with the customer's verified domain created within the previous 48 hours will not…
  • POSTSends a UserInvitation to email/v1/:name:sendSends a UserInvitation to email. If the UserInvitation does not exist for this request and it is a valid request, the request creates a UserInvitation. Note:…

devices.deviceUsers

  • POSTCancels an unfinished user account wipe/v1/:name:cancelWipeCancels 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…
  • POSTWipes the user's account on a device/v1/:name:wipeWipes the user's account on a device. Other data on the device that is not associated with the user's work account is not affected. For example, if a Gmail…
  • POSTApproves device to access user data./v1/:name:approveApproves device to access user data.
  • POSTBlocks device from accessing user data/v1/:name:blockBlocks device from accessing user data
  • GETLists/Searches DeviceUsers./v1/:parent/deviceUsers?customer=string&filter=string&orderBy=string&pageSize=0&pageToken=stringLists/Searches DeviceUsers.
  • GETLooks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties…/v1/:parent:lookup?androidId=string&iosDeviceId=string&pageSize=0&pageToken=string&partner=string&rawResourceId=string&userId=stringLooks 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…

devices

  • GETLists/Searches devices./v1/devices?customer=string&filter=string&orderBy=string&pageSize=0&pageToken=string&view=VIEW_UNSPECIFIEDLists/Searches devices.
  • POSTCreates a device/v1/devices?customer=stringCreates 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…

devices.deviceUsers.clientStates

  • GETLists the client states for the given search query./v1/:parent/clientStates?customer=string&filter=string&orderBy=string&pageToken=stringLists the client states for the given search query.

groups

  • GETLists the `Group` resources under a customer or namespace./v1/groups?pageSize=0&pageToken=string&parent=string&view=VIEW_UNSPECIFIEDLists the Group resources under a customer or namespace.
  • POSTCreates a Group./v1/groups?initialGroupConfig=INITIAL_GROUP_CONFIG_UNSPECIFIEDCreates a Group.
  • GETLooks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by its `EntityKey`./v1/groups:lookup?groupKey.id=string&groupKey.namespace=stringLooks up the resource name of a Group by its EntityKey.
  • GETSearches for `Group` resources matching a specified query./v1/groups:search?pageSize=0&pageToken=string&query=string&view=VIEW_UNSPECIFIEDSearches for Group resources matching a specified query.

groups.memberships

  • GETCheck a potential member for membership in a group/v1/:parent/memberships:checkTransitiveMembership?query=stringCheck a potential member for membership in a group. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and…
  • GETLists the `Membership`s within a `Group`./v1/:parent/memberships?pageSize=0&pageToken=string&view=VIEW_UNSPECIFIEDLists the Memberships within a Group.
  • POSTCreates a `Membership`./v1/:parent/membershipsCreates a Membership.
  • GETGet a membership graph of just a member or both a member and a group/v1/:parent/memberships:getMembershipGraph?query=stringGet 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…
  • GETLooks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Membership` by its `EntityKey`./v1/:parent/memberships:lookup?memberKey.id=string&memberKey.namespace=stringLooks up the resource name of a Membership by its EntityKey.
  • POSTModifies the `MembershipRole`s of a `Membership`./v1/:name:modifyMembershipRolesModifies the MembershipRoles of a Membership.
  • GETSearches direct groups of a member/v1/:parent/memberships:searchDirectGroups?orderBy=string&pageSize=0&pageToken=string&query=stringSearches direct groups of a member. Groups for which the actor does not have the permission to view memberships are silently filtered out.
  • GETSearch transitive groups of a member/v1/:parent/memberships:searchTransitiveGroups?pageSize=0&pageToken=string&query=stringSearch transitive groups of a member. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for…
  • GETSearch transitive memberships of a group/v1/:parent/memberships:searchTransitiveMemberships?pageSize=0&pageToken=stringSearch transitive memberships of a group. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for…

inboundOidcSsoProfiles

  • GETLists InboundOidcSsoProfile objects for a Google enterprise customer./v1/inboundOidcSsoProfiles?filter=string&pageSize=0&pageToken=stringLists InboundOidcSsoProfile objects for a Google enterprise customer.
  • POSTCreates an InboundOidcSsoProfile for a customer/v1/inboundOidcSsoProfilesCreates an InboundOidcSsoProfile for a customer. When the target customer has enabled Multi-party approval for sensitive actions, the Operation in the…

inboundSamlSsoProfiles

  • GETLists InboundSamlSsoProfiles for a customer./v1/inboundSamlSsoProfiles?filter=string&pageSize=0&pageToken=stringLists InboundSamlSsoProfiles for a customer.
  • POSTCreates an InboundSamlSsoProfile for a customer/v1/inboundSamlSsoProfilesCreates an InboundSamlSsoProfile for a customer. When the target customer has enabled Multi-party approval for sensitive actions, the Operation in the…

inboundSamlSsoProfiles.idpCredentials

  • POSTAdds an IdpCredential/v1/:parent/idpCredentials:addAdds an IdpCredential. Up to 2 credentials are allowed. When the target customer has enabled Multi-party approval for sensitive actions, the Operation in the…
  • GETReturns a list of IdpCredentials in an InboundSamlSsoProfile./v1/:parent/idpCredentials?pageSize=0&pageToken=stringReturns a list of IdpCredentials in an InboundSamlSsoProfile.

inboundSsoAssignments

  • GETLists the InboundSsoAssignments for a `Customer`./v1/inboundSsoAssignments?filter=string&pageSize=0&pageToken=stringLists the InboundSsoAssignments for a Customer.
  • POSTCreates an InboundSsoAssignment for users and devices in a `Customer` under a given `Group` or `OrgUnit`./v1/inboundSsoAssignmentsCreates an InboundSsoAssignment for users and devices in a Customer under a given Group or OrgUnit.

API details

Base URL
https://cloudidentity.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 12 scopes
An API key in the key query parameter
Operations
41 operations on 31 pathsGET 23POST 16PATCH 1DELETE 1
Main resources
groups.memberships 9devices.deviceUsers 6policies 5customers.userinvitations 4groups 4allowlistedDomains 2devices 2inboundOidcSsoProfiles 2inboundSamlSsoProfiles 2inboundSamlSsoProfiles.idpCredentials 2
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Cloud Identity API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Cloud Identity API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 12 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Lists the domains in the allowlist.” (GET /v1/allowlistedDomains?filter=string&pageSize=0&pageToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Cloud Identity API?

API for provisioning and managing identity resources. It is listed under Identity & security and has 41 endpoints.

Who publishes the Cloud Identity API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Cloud Identity API?

Requests go to https://cloudidentity.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Cloud Identity API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 12 scopes; an API key in the key query parameter.

How many endpoints does the Cloud Identity API have?

41 operations on 31 paths (23 GET, 16 POST, 1 PATCH, 1 DELETE). The largest groups are groups.memberships, devices.deviceUsers, policies, customers.userinvitations.

Is forking the Cloud Identity API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.