Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/google-workspace:google-workspace-customers-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Cloud Identity Customers API
version: v1
description: Generated from Google's published Discovery document for Cloud Identity API (cloudidentity v1, revision 20261108). 5 operation(s).
contact:
name: Google
url: https://developers.google.com/
termsOfService: https://developers.google.com/terms
servers:
- url: https://cloudidentity.googleapis.com
tags:
- name: Customers
paths:
/v1/customers/{customersId}/userinvitations/{userinvitationsId}:cancel:
post:
operationId: cloudidentity.customers.userinvitations.cancel
summary: Cancel userinvitations
description: Cancels a UserInvitation that was already sent.
parameters:
- name: customersId
in: path
required: true
description: Resource name segment (customersId).
schema:
type: string
- name: userinvitationsId
in: path
required: true
description: Resource name segment (userinvitationsId).
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CancelUserInvitationRequest'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Operation'
4XX:
content:
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content:
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: Error response (google.rpc.Status)
security:
- apiKey: []
tags:
- Customers
/v1/customers/{customersId}/userinvitations/{userinvitationsId}:
get:
operationId: cloudidentity.customers.userinvitations.get
summary: Get userinvitations
description: Retrieves a UserInvitation resource. **Note:** New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains.
parameters:
- name: customersId
in: path
required: true
description: Resource name segment (customersId).
schema:
type: string
- name: userinvitationsId
in: path
required: true
description: Resource name segment (userinvitationsId).
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/UserInvitation'
4XX:
content:
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content:
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: Error response (google.rpc.Status)
security:
- apiKey: []
tags:
- Customers
/v1/customers/{customersId}/userinvitations/{userinvitationsId}:isInvitableUser:
get:
operationId: cloudidentity.customers.userinvitations.isInvitableUser
summary: Is invitable user userinvitations
description: 'Verifies whether a user account is eligible to receive a UserInvitation (is an unmanaged account). Eligibility is based on the following criteria: * the email address is a consumer account and it''s the primary email address of the account, and * the domain of the email address matches an existing verified Google Workspace or Cloud Identity domain If both conditions are met, the user is eligible. **Note:** This method is not supported for Workspace Essentials customers.'
parameters:
- name: customersId
in: path
required: true
description: Resource name segment (customersId).
schema:
type: string
- name: userinvitationsId
in: path
required: true
description: Resource name segment (userinvitationsId).
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/IsInvitableUserResponse'
4XX:
content:
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content:
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: Error response (google.rpc.Status)
security:
- apiKey: []
tags:
- Customers
/v1/customers/{customersId}/userinvitations/{userinvitationsId}:send:
post:
operationId: cloudidentity.customers.userinvitations.send
summary: Send userinvitations
description: Sends 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:** The `get` and `list` methods have a 48-hour delay where newly-created consumer accounts will not appear in the results. You can still send a `UserInvitation` to those accounts if you know the unmanaged email address and IsInvitableUser==True.
parameters:
- name: customersId
in: path
required: true
description: Resource name segment (customersId).
schema:
type: string
- name: userinvitationsId
in: path
required: true
description: Resource name segment (userinvitationsId).
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SendUserInvitationRequest'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Operation'
4XX:
content:
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content:
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: Error response (google.rpc.Status)
security:
- apiKey: []
tags:
- Customers
/v1/customers/{customersId}/userinvitations:
get:
operationId: cloudidentity.customers.userinvitations.list
summary: List userinvitations
description: Retrieves a list of UserInvitation resources. **Note:** New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains.
parameters:
- name: customersId
in: path
required: true
description: Resource name segment (customersId).
schema:
type: string
- name: filter
in: query
required: false
description: 'Optional. A query string for filtering `UserInvitation` results by their current state, in the format: `"state==''invited''"`.'
schema:
type: string
- name: orderBy
in: query
required: false
description: Optional. The sort order of the list results. You can sort the results in descending order based on either email or last update timestamp but not both, using `order_by="email desc"`. Currently, sorting is supported for `update_time asc`, `update_time desc`, `email asc`, and `email desc`. If not specified, results will be returned based on `email asc` order.
schema:
type: string
- name: pageSize
in: query
required: false
description: Optional. The maximum number of UserInvitation resources to return. If unspecified, at most 100 resources will be returned. The maximum value is 200; values above 200 will be set to 200.
schema:
type: integer
format: int32
- name: pageToken
in: query
required: false
description: Optional. A page token, received from a previous `ListUserInvitations` 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.
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListUserInvitationsResponse'
4XX:
content:
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content:
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: Error response (google.rpc.Status)
security:
- apiKey: []
tags:
- Customers
components:
schemas:
CancelUserInvitationRequest:
properties: {}
type: object
description: Request to cancel sent invitation for target email in UserInvitation.
ListUserInvitationsResponse:
description: Response message for UserInvitation listing request.
properties:
nextPageToken:
description: The token for the next page. If not empty, indicates that there may be more `UserInvitation` resources that match the listing request; this value can be used in a subsequent ListUserInvitationsRequest to get continued results with the current list call.
type: string
userInvitations:
items:
$ref: '#/components/schemas/UserInvitation'
description: The list of UserInvitation resources.
type: array
type: object
GoogleRpcError:
type: object
description: The error envelope every Google API returns.
properties:
error:
type: object
properties:
code:
type: integer
message:
type: string
status:
type: string
details:
type: array
items:
type: object
Status:
properties:
message:
description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
type: string
details:
description: A list of messages that carry the error details. There is a common set of message types for APIs to use.
type: array
items:
type: object
additionalProperties:
description: Properties of the object. Contains field @type with type URL.
code:
description: The status code, which should be an enum value of google.rpc.Code.
format: int32
type: integer
description: 'The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).'
type: object
UserInvitation:
properties:
name:
description: Shall be of the form `customers/{customer}/userinvitations/{user_email_address}`.
type: string
state:
description: State of the `UserInvitation`.
type: string
enum:
- STATE_UNSPECIFIED
- NOT_YET_SENT
- INVITED
- ACCEPTED
- DECLINED
mailsSentCount:
format: int64
type: string
description: Number of invitation emails sent to the user.
updateTime:
format: google-datetime
type: string
description: Time when the `UserInvitation` was last updated.
description: The `UserInvitation` resource represents an email that can be sent to an unmanaged user account inviting them to join the customer's Google Workspace or Cloud Identity account. An unmanaged account shares an email address domain with the Google Workspace or Cloud Identity account but is not managed by it yet. If the user accepts the `UserInvitation`, the user account will become managed.
type: object
SendUserInvitationRequest:
type: object
properties: {}
description: A request to send email for inviting target user corresponding to the UserInvitation.
IsInvitableUserResponse:
properties:
isInvitableUser:
description: Returns true if the email address is invitable.
type: boolean
type: object
description: Response for IsInvitableUser RPC.
Operation:
properties:
metadata:
description: Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
additionalProperties:
description: Properties of the object. Contains field @type with type URL.
type: object
error:
$ref: '#/components/schemas/Status'
description: The error result of the operation in case of failure or cancellation.
name:
description: The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
type: string
done:
description: If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
type: boolean
response:
additionalProperties:
description: Properties of the object. Contains field @type with type URL.
type: object
description: The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
description: This resource represents a long-running operation that is the result of a network API call.
type: object
securitySchemes:
apiKey:
type: apiKey
in: query
name: key
description: API key; accepted by methods that do not need user data.
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://accounts.google.com/o/oauth2/auth
tokenUrl: https://oauth2.googleapis.com/token
scopes:
https://www.googleapis.com/auth/cloud-identity.policies: See and edit policies in your Cloud Identity Organization.
https://www.googleapis.com/auth/cloud-identity.inboundsso: See and edit all of the Inbound SSO profiles and their assignments to any Org Units or Google Groups in your Cloud Identity Organization.
https://www.googleapis.com/auth/cloud-identity.devices.readonly: 'Private Service: https://www.googleapis.com/auth/cloud-identity.devices.readonly'
https://www.googleapis.com/auth/cloud-identity.groups.readonly: See any Cloud Identity Groups that you can access, including group members and their emails
https://www.googleapis.com/auth/cloud-identity.devices: 'Private Service: https://www.googleapis.com/auth/cloud-identity.devices'
https://www.googleapis.com/auth/cloud-platform: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
https://www.googleapis.com/auth/cloud-identity.allowlisteddomains: See and edit allowlisted domains in your Cloud Identity Organization
https://www.googleapis.com/auth/cloud-identity.allowlisteddomains.readonly: See allowlisted domains in your Cloud Identity Organization
https://www.googleapis.com/auth/cloud-identity.policies.readonly: See policies in your Cloud Identity Organization.
https://www.googleapis.com/auth/cloud-identity.devices.lookup: See your device details
https://www.googleapis.com/auth/cloud-identity.inboundsso.readonly: See all of the Inbound SSO profiles and their assignments to any Org Units or Google Groups in your Cloud Identity Organization.
https://www.googleapis.com/auth/cloud-identity.groups: See, change, create, and delete any of the Cloud Identity Groups that you can access, including the members of each group
externalDocs:
url: https://cloud.google.com/identity/
x-provenance:
method: harvested
publisher: Google
source: https://cloudidentity.googleapis.com/$discovery/rest?version=v1
note: converted by discovery-to-openapi.py from Google's Discovery document (revision 20261108)