REST Resource: locations.workforcePools.providers.scimTenants

Resource: WorkforcePoolProviderScimTenant

Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.

JSON representation 
{
  "name": string,
  "baseUri": string,
  "state": enum (State),
  "description": string,
  "displayName": string,
  "claimMapping": {
    string: string,
    ...
  },
  "purgeTime": string,
  "serviceAgent": string
}
Fields
name

string

Identifier. Agentspace only. The resource name of the SCIM Tenant.

Format: locations/{location}/workforcePools/{workforcePool}/providers/ {workforcePoolProvider}/scimTenants/{scim_tenant}
baseUri

string

Output only. Agentspace only. Represents the base URI as defined in RFC 7644, Section 1.3. Clients must use this as the root address for managing resources under the tenant.

Format: https://iamscim.googleapis.com/{version}/{tenantId}/
state

enum (State)

Output only. Agentspace only. The state of the tenant.
description

string

Optional. Agentspace only. The description of the SCIM tenant.

Cannot exceed 256 characters.
displayName

string

Optional. Agentspace only. The display name of the SCIM tenant.

Cannot exceed 32 characters.
claimMapping

map (key: string, value: string)

Optional. Agentspace only. Maps BYOID claims to SCIM claims.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
purgeTime

string (Timestamp format)

Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
serviceAgent

string

Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent.

State

Agentspace only. The current state of the SCIM tenant.

Enums
STATE_UNSPECIFIED Agentspace only. State unspecified.
ACTIVE Agentspace only. The tenant is active and may be used to provision users and groups.
DELETED Agentspace only. The tenant is soft-deleted. Soft-deleted tenants are permanently deleted after approximately 30 days.

Methods

create

 Agentspace only.

delete

 Agentspace only.

get

 Agentspace only.

list

 Agentspace only.

patch

 Agentspace only.

undelete

 Agentspace only.