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

## Instance Methods

Returns the tokens Resource.

Close httplib2 connections.

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

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.

Gets an individual WorkforcePoolProviderScimTenant.

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.

Updates an existing WorkforcePoolProviderScimTenant.

Undeletes a WorkforcePoolProviderScimTenant, as long as it was deleted fewer than 30 days ago.

### Method Details

`close()`

    Close httplib2 connections.

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

    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. 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:

    { # 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. 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. Maps BYOID claims to SCIM claims.
        "a_key": "A String",
      },
      "description": "A String", # Optional. The user-specified description of the scim tenant. Cannot exceed 256 characters.
      "displayName": "A String", # Optional. The user-specified display name of the scim tenant. Cannot exceed 32 characters.
      "name": "A String", # Identifier. 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. The timestamp when the scim tenant is going to be purged.
      "state": "A String", # Output only. The state of the tenant.
    }

      workforcePoolProviderScimTenantId: string, Required. The ID to use for the scim tenant, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain 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:

        { # 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. 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. Maps BYOID claims to SCIM claims.
        "a_key": "A String",
      },
      "description": "A String", # Optional. The user-specified description of the scim tenant. Cannot exceed 256 characters.
      "displayName": "A String", # Optional. The user-specified display name of the scim tenant. Cannot exceed 32 characters.
      "name": "A String", # Identifier. 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. The timestamp when the scim tenant is going to be purged.
      "state": "A String", # Output only. The state of the tenant.
    }

`delete(name, x__xgafv=None)`

    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. The name of the scim tenant to delete. 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:

        { # 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. 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. Maps BYOID claims to SCIM claims.
        "a_key": "A String",
      },
      "description": "A String", # Optional. The user-specified description of the scim tenant. Cannot exceed 256 characters.
      "displayName": "A String", # Optional. The user-specified display name of the scim tenant. Cannot exceed 32 characters.
      "name": "A String", # Identifier. 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. The timestamp when the scim tenant is going to be purged.
      "state": "A String", # Output only. The state of the tenant.
    }

`get(name, x__xgafv=None)`

    Gets an individual WorkforcePoolProviderScimTenant.

    Args:
      name: string, Required. 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:

        { # 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. 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. Maps BYOID claims to SCIM claims.
        "a_key": "A String",
      },
      "description": "A String", # Optional. The user-specified description of the scim tenant. Cannot exceed 256 characters.
      "displayName": "A String", # Optional. The user-specified display name of the scim tenant. Cannot exceed 32 characters.
      "name": "A String", # Identifier. 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. The timestamp when the scim tenant is going to be purged.
      "state": "A String", # Output only. The state of the tenant.
    }

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

    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. The parent to list scim tenants. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}' (required)
      pageSize: integer, Optional. The maximum number of scim tenants to return. If unspecified, at most 1 scim tenant will be returned.
      pageToken: string, Optional. A page token, received from a previous `ListScimTenants` call. Provide this to retrieve the subsequent page.
      showDeleted: boolean, Optional. 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:

        { # Response message for ListWorkforcePoolProviderScimTenants.
      "nextPageToken": "A String", # Optional. 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. A list of scim tenants.
        { # 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. 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. Maps BYOID claims to SCIM claims.
            "a_key": "A String",
          },
          "description": "A String", # Optional. The user-specified description of the scim tenant. Cannot exceed 256 characters.
          "displayName": "A String", # Optional. The user-specified display name of the scim tenant. Cannot exceed 32 characters.
          "name": "A String", # Identifier. 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. The timestamp when the scim tenant is going to be purged.
          "state": "A String", # Output 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)`

    Updates an existing WorkforcePoolProviderScimTenant.

    Args:
      name: string, Identifier. 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:

    { # 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. 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. Maps BYOID claims to SCIM claims.
        "a_key": "A String",
      },
      "description": "A String", # Optional. The user-specified description of the scim tenant. Cannot exceed 256 characters.
      "displayName": "A String", # Optional. The user-specified display name of the scim tenant. Cannot exceed 32 characters.
      "name": "A String", # Identifier. 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. The timestamp when the scim tenant is going to be purged.
      "state": "A String", # Output only. The state of the tenant.
    }

      updateMask: string, Optional. 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:

        { # 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. 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. Maps BYOID claims to SCIM claims.
        "a_key": "A String",
      },
      "description": "A String", # Optional. The user-specified description of the scim tenant. Cannot exceed 256 characters.
      "displayName": "A String", # Optional. The user-specified display name of the scim tenant. Cannot exceed 32 characters.
      "name": "A String", # Identifier. 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. The timestamp when the scim tenant is going to be purged.
      "state": "A String", # Output only. The state of the tenant.
    }

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

    Undeletes a WorkforcePoolProviderScimTenant, as long as it was deleted fewer than 30 days ago.

    Args:
      name: string, Required. 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:

    { # 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:

        { # 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. 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. Maps BYOID claims to SCIM claims.
        "a_key": "A String",
      },
      "description": "A String", # Optional. The user-specified description of the scim tenant. Cannot exceed 256 characters.
      "displayName": "A String", # Optional. The user-specified display name of the scim tenant. Cannot exceed 32 characters.
      "name": "A String", # Identifier. 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. The timestamp when the scim tenant is going to be purged.
      "state": "A String", # Output only. The state of the tenant.
    }