# Identity and Access Management (IAM) API . locations . workforcePools . providers . scimTenants

## Instance Methods

Returns the tokens Resource.

Close httplib2 connections.

Agentspace only. Creates a new WorkforcePoolProviderScimTenant in a WorkforcePoolProvider. You cannot reuse the name of a deleted SCIM tenant until 30 days after deletion.

Agentspace only. Deletes a WorkforcePoolProviderScimTenant. You can undelete a SCIM tenant for 30 days. After 30 days, deletion is permanent. You cannot update deleted SCIM tenants. However, you can view and list them.

Agentspace only. Gets an individual WorkforcePoolProviderScimTenant.

Agentspace only. Lists all non-deleted WorkforcePoolProviderScimTenants in a WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted SCIM tenants are also listed.

Retrieves the next page of results.

Agentspace only. Updates an existing WorkforcePoolProviderScimTenant.

Agentspace only. Undeletes a WorkforcePoolProviderScimTenant, that was deleted fewer than 30 days ago.

### Method Details

`close()`

    Close httplib2 connections.

`create(parent, body=None, workforcePoolProviderScimTenantId=None, x__xgafv=None)`

    Agentspace only. Creates a new WorkforcePoolProviderScimTenant in a WorkforcePoolProvider. You cannot reuse the name of a deleted SCIM tenant until 30 days after deletion.

    Args:
      parent: string, Required. Agentspace only. The parent to create SCIM tenant. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}' (required)
      body: object, The request body.
        The object takes the form of:

    { # Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.
      "baseUri": "A String", # Output only. Agentspace only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/
      "claimMapping": { # Optional. Agentspace only. Maps BYOID claims to SCIM claims.
        "a_key": "A String",
      },
      "description": "A String", # Optional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters.
      "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters.
      "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
      "purgeTime": "A String", # Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged.
      "serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent.
      "state": "A String", # Output only. Agentspace only. The state of the tenant.
    }

      workforcePoolProviderScimTenantId: string, Required. Agentspace only. The ID to use for the SCIM tenant, which becomes the final component of the resource name. This value should be 4-32 characters, containing the characters [a-z0-9-].
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.
      "baseUri": "A String", # Output only. Agentspace only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/
      "claimMapping": { # Optional. Agentspace only. Maps BYOID claims to SCIM claims.
        "a_key": "A String",
      },
      "description": "A String", # Optional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters.
      "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters.
      "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
      "purgeTime": "A String", # Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged.
      "serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent.
      "state": "A String", # Output only. Agentspace only. The state of the tenant.
    }

`delete(name, hardDelete=None, x__xgafv=None)`

    Agentspace only. Deletes a WorkforcePoolProviderScimTenant. You can undelete a SCIM tenant for 30 days. After 30 days, deletion is permanent. You cannot update deleted SCIM tenants. However, you can view and list them.

    Args:
      name: string, Required. Agentspace only. The name of the scim tenant to delete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}` (required)
      hardDelete: boolean, Optional. Deletes the SCIM tenant immediately. This operation cannot be undone.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.
      "baseUri": "A String", # Output only. Agentspace only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/
      "claimMapping": { # Optional. Agentspace only. Maps BYOID claims to SCIM claims.
        "a_key": "A String",
      },
      "description": "A String", # Optional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters.
      "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters.
      "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
      "purgeTime": "A String", # Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged.
      "serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent.
      "state": "A String", # Output only. Agentspace only. The state of the tenant.
    }

`get(name, x__xgafv=None)`

    Agentspace only. Gets an individual WorkforcePoolProviderScimTenant.

    Args:
      name: string, Required. Agentspace only. The name of the SCIM tenant to retrieve. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}` (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.
      "baseUri": "A String", # Output only. Agentspace only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/
      "claimMapping": { # Optional. Agentspace only. Maps BYOID claims to SCIM claims.
        "a_key": "A String",
      },
      "description": "A String", # Optional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters.
      "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters.
      "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
      "purgeTime": "A String", # Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged.
      "serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent.
      "state": "A String", # Output only. Agentspace only. The state of the tenant.
    }

`list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)`

    Agentspace only. Lists all non-deleted WorkforcePoolProviderScimTenants in a WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted SCIM tenants are also listed.

    Args:
      parent: string, Required. Agentspace only. The parent to list SCIM tenants. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}' (required)
      pageSize: integer, Optional. Agentspace only. The maximum number of SCIM tenants to return. If unspecified, at most 1 scim tenant will be returned.
      pageToken: string, Optional. Agentspace only. A page token, received from a previous `ListScimTenants` call. Provide this to retrieve the subsequent page.
      showDeleted: boolean, Optional. Agentspace only. Whether to return soft-deleted SCIM tenants.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Agentspace only. Response message for ListWorkforcePoolProviderScimTenants.
      "nextPageToken": "A String", # Optional. Agentspace only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
      "workforcePoolProviderScimTenants": [ # Output only. Agentspace only. A list of SCIM tenants.
        { # Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.
          "baseUri": "A String", # Output only. Agentspace only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/
          "claimMapping": { # Optional. Agentspace only. Maps BYOID claims to SCIM claims.
            "a_key": "A String",
          },
          "description": "A String", # Optional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters.
          "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters.
          "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
          "purgeTime": "A String", # Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged.
          "serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent.
          "state": "A String", # Output only. Agentspace only. The state of the tenant.
        },
      ],
    }

`list_next()`

    Retrieves the next page of results.

            Args:
              previous_request: The request for the previous page. (required)
              previous_response: The response from the request for the previous page. (required)

            Returns:
              A request object that you can call 'execute()' on to request the next
              page. Returns None if there are no more items in the collection.

`patch(name, body=None, updateMask=None, x__xgafv=None)`

    Agentspace only. Updates an existing WorkforcePoolProviderScimTenant.

    Args:
      name: string, Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` (required)
      body: object, The request body.
        The object takes the form of:

    { # Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.
      "baseUri": "A String", # Output only. Agentspace only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/
      "claimMapping": { # Optional. Agentspace only. Maps BYOID claims to SCIM claims.
        "a_key": "A String",
      },
      "description": "A String", # Optional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters.
      "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters.
      "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
      "purgeTime": "A String", # Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged.
      "serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent.
      "state": "A String", # Output only. Agentspace only. The state of the tenant.
    }

      updateMask: string, Optional. Agentspace only. The list of fields to update.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.
      "baseUri": "A String", # Output only. Agentspace only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/
      "claimMapping": { # Optional. Agentspace only. Maps BYOID claims to SCIM claims.
        "a_key": "A String",
      },
      "description": "A String", # Optional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters.
      "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters.
      "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
      "purgeTime": "A String", # Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged.
      "serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent.
      "state": "A String", # Output only. Agentspace only. The state of the tenant.
    }

`undelete(name, body=None, x__xgafv=None)`

    Agentspace only. Undeletes a WorkforcePoolProviderScimTenant, that was deleted fewer than 30 days ago.

    Args:
      name: string, Required. Agentspace only. The name of the SCIM tenant to undelete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}` (required)
      body: object, The request body.
        The object takes the form of:

    { # Agentspace only. Request message for UndeleteWorkforcePoolProviderScimTenant.
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.
      "baseUri": "A String", # Output only. Agentspace only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/
      "claimMapping": { # Optional. Agentspace only. Maps BYOID claims to SCIM claims.
        "a_key": "A String",
      },
      "description": "A String", # Optional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters.
      "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters.
      "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
      "purgeTime": "A String", # Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged.
      "serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent.
      "state": "A String", # Output only. Agentspace only. The state of the tenant.
    }