Sign in

v3

latestOpenAPI 3.0.32026-07-31112307733.3 KB
google-login

Partial Update Google Login

Partial Update an existing Google Login.

The base rate limit for this endpoint is:

  • 300 requests per min per workspace
patch/api/v2/google-logins/{id}/

Path parameters

idstring uuid required

A UUID string identifying this google login.

Request body

emailstring email

The email address of the google account to use for login.

is_activeboolean

If the login should be used for round robin. (default: true)

sso_v2_workspace_domainstring

The primary domain name of your Google Workspace Account used for SSO.

sso_v2_private_keystring

PEM-formatted private key used for signing SSO requests.

sso_v2_certstring

PEM-formatted x509 certificate which is registered in your Google Workspace SSO Profile.

group_idstring uuid

The id of the login group this login belongs to.

Response

idstring uuid required
emailstring email required

The email address of the google account to use for login.

is_activeboolean

If the login should be used for round robin. (default: true)

sso_v2_workspace_domainstring required

The primary domain name of your Google Workspace Account used for SSO.

sso_v2_private_keystring required

PEM-formatted private key used for signing SSO requests.

sso_v2_certstring required

PEM-formatted x509 certificate which is registered in your Google Workspace SSO Profile.

group_idstring uuid required

The id of the login group this login belongs to.

created_atstring date-time required
updated_atstring date-time required