Skip to content

Cloud Identity API API

by googleapis.com

OAuthHTTPSAnalytics
Open documentation ↗

Overview

API for provisioning and managing identity resources.

Cloud Identity API is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 35 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Analytics
Base URL
https://cloudidentity.googleapis.com/
Version
v1beta1
Endpoints
35
Spec updated
2023-04-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://cloudidentity.googleapis.com/v1beta1/devices" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://cloudidentity.googleapis.com/v1beta1/devices", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://cloudidentity.googleapis.com/v1beta1/devices",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/v1beta1/devicesLists/Searches devices.
POST/v1beta1/devicesCreates 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
GET/v1beta1/groupsLists the `Group` resources under a customer or namespace.
POST/v1beta1/groupsCreates a `Group`.
GET/v1beta1/groups:lookupLooks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by its `EntityKey`.
GET/v1beta1/groups:searchSearches for `Group` resources matching a specified query.
GET/v1beta1/inboundSamlSsoProfilesLists InboundSamlSsoProfiles for a customer.
POST/v1beta1/inboundSamlSsoProfilesCreates an InboundSamlSsoProfile for a customer.
GET/v1beta1/inboundSsoAssignmentsLists the InboundSsoAssignments for a `Customer`.
POST/v1beta1/inboundSsoAssignmentsCreates an InboundSsoAssignment for users and devices in a `Customer` under a given `Group` or `OrgUnit`.
GET/v1beta1/{name}Gets an InboundSsoAssignment.
PATCH/v1beta1/{name}Updates an InboundSsoAssignment. The body of this request is the `inbound_sso_assignment` field and the `update_mask` is relative to that. For example: a PATCH
DELETE/v1beta1/{name}Deletes an InboundSsoAssignment. To disable SSO, Create (or Update) an assignment that has `sso_mode` == `SSO_OFF`.
POST/v1beta1/{name}:approveApproves device to access user data.
POST/v1beta1/{name}:blockBlocks device from accessing user data
POST/v1beta1/{name}:cancelCancels a UserInvitation that was already sent.
POST/v1beta1/{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 device
GET/v1beta1/{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 a
POST/v1beta1/{name}:modifyMembershipRolesModifies the `MembershipRole`s of a `Membership`.
POST/v1beta1/{name}:moveMove an OrgMembership to a new OrgUnit. NOTE: This is an atomic copy-and-delete. The resource will have a new copy under the destination OrgUnit and be deleted
POST/v1beta1/{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`. **No
POST/v1beta1/{name}:wipeWipes the user's account on a device.
GET/v1beta1/{parent}/deviceUsersLists/Searches DeviceUsers.
GET/v1beta1/{parent}/idpCredentialsReturns a list of IdpCredentials in an InboundSamlSsoProfile.
POST/v1beta1/{parent}/idpCredentials:addAdds an IdpCredential. Up to 2 credentials are allowed.
GET/v1beta1/{parent}/membershipsList OrgMembership resources in an OrgUnit treated as 'parent'. Parent format: orgUnits/{$orgUnitId} where `$orgUnitId` is the `orgUnitId` from the [Admin SDK `
POST/v1beta1/{parent}/membershipsCreates a `Membership`.
GET/v1beta1/{parent}/memberships:checkTransitiveMembershipCheck a potential member for membership in a group. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enter
GET/v1beta1/{parent}/memberships:getMembershipGraphGet 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, Enterpri
GET/v1beta1/{parent}/memberships:lookupLooks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Membership` by its `EntityKey`.
GET/v1beta1/{parent}/memberships:searchDirectGroupsSearches direct groups of a member.
GET/v1beta1/{parent}/memberships:searchTransitiveGroupsSearch transitive groups of a member. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Educ
GET/v1beta1/{parent}/memberships:searchTransitiveMembershipsSearch transitive memberships of a group. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for
GET/v1beta1/{parent}/userinvitationsRetrieves a list of UserInvitation resources. **Note:** New consumer accounts with the customer's verified domain created within the previous 48 hours will not
GET/v1beta1/{parent}:lookupLooks 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 call

Questions

Does the Cloud Identity API API need an API key?

Yes. The Cloud Identity API API uses OAuth authentication; the documentation explains how to get credentials.

Does the Cloud Identity API API support HTTPS?

Yes, the Cloud Identity API API is served over HTTPS.

How many endpoints does the Cloud Identity API API have?

Its OpenAPI description lists 35 endpoints in version v1beta1. All of them are shown on this page.

What are alternatives to the Cloud Identity API API?

Other Analytics APIs include Google Play Integrity API, versionhistory.googleapis.com API, Doc Converter, Perspective Comment Analyzer API, Safe Browsing API.

Compare alternatives →

Google Play Integrity API

Analytics

The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.

OAuth1 endpoints

versionhistory.googleapis.com API

Analytics

Version History API - Prod

No auth4 endpoints

Doc Converter

Analytics

This api converts file formats of OpenXml and OpenOffice documents formats to vector files (e.g., svg)

No auth1 endpoints

Perspective Comment Analyzer API

Analytics

The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned.

OAuth2 endpoints

Safe Browsing API

Analytics

Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.

No auth7 endpoints

Web Fonts Developer API

Analytics

The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.

No auth1 endpoints

Listed from APIs.guru (CC0).