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

close()

Close httplib2 connections.

create(parent, body=None, workforcePoolProviderScimTokenId=None, x__xgafv=None)

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

Args:
  parent: string, Required. Agentspace only. The parent tenant to create SCIM token. 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. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests.
  "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM token. Cannot exceed 32 characters.
  "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
  "securityToken": "A String", # Output only. Agentspace only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
  "state": "A String", # Output only. Agentspace only. The state of the token.
}

  workforcePoolProviderScimTokenId: string, Required. Agentspace only. The ID to use for the SCIM token, which becomes the final component of the resource name. This value should be 4-32 characters and follow the pattern: "([a-z]([a-z0-9\\-]{2,30}[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 token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests.
  "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM token. Cannot exceed 32 characters.
  "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
  "securityToken": "A String", # Output only. Agentspace only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
  "state": "A String", # Output only. Agentspace only. The state of the token.
}

delete(name, x__xgafv=None)

Agentspace only. Deletes a WorkforcePoolProviderScimToken. You can undelete a SCIM token for 30 days. After 30 days, the SCIM token is permanently deleted. You cannot update deleted SCIM tokens, however, you can view and list them.

Args:
  name: string, Required. Agentspace only. The name of the SCIM token to delete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}` (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 token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests.
  "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM token. Cannot exceed 32 characters.
  "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
  "securityToken": "A String", # Output only. Agentspace only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
  "state": "A String", # Output only. Agentspace only. The state of the token.
}

get(name, x__xgafv=None)

Agentspace only. Gets an individual WorkforcePoolProviderScimToken.

Args:
  name: string, Required. Agentspace only. The name of the SCIM token to retrieve. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}` (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 token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests.
  "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM token. Cannot exceed 32 characters.
  "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
  "securityToken": "A String", # Output only. Agentspace only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
  "state": "A String", # Output only. Agentspace only. The state of the token.
}

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

Agentspace only. Lists all non-deleted WorkforcePoolProviderScimTokenss in a WorkforcePoolProviderScimTenant. If `show_deleted` is set to `true`, then deleted SCIM tokens are also listed.

Args:
  parent: string, Required. Agentspace only. The parent to list SCIM tokens. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}' (required)
  pageSize: integer, Optional. Agentspace only. The maximum number of scim tokens to return. If unspecified, at most 2 SCIM tokens will be returned.
  pageToken: string, Optional. Agentspace only. A page token, received from a previous `ListWorkforcePoolProviderScimTokens` call. Provide this to retrieve the subsequent page.
  showDeleted: boolean, Optional. Agentspace only. Whether to return soft-deleted scim tokens.
  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 ListWorkforcePoolProviderScimTokens.
  "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.
  "workforcePoolProviderScimTokens": [ # Output only. Agentspace only. A list of SCIM tokens.
    { # Agentspace only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests.
      "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM token. Cannot exceed 32 characters.
      "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
      "securityToken": "A String", # Output only. Agentspace only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
      "state": "A String", # Output only. Agentspace only. The state of the token.
    },
  ],
}

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

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

{ # Agentspace only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests.
  "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM token. Cannot exceed 32 characters.
  "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
  "securityToken": "A String", # Output only. Agentspace only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
  "state": "A String", # Output only. Agentspace only. The state of the token.
}

  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 token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests.
  "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM token. Cannot exceed 32 characters.
  "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
  "securityToken": "A String", # Output only. Agentspace only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
  "state": "A String", # Output only. Agentspace only. The state of the token.
}

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

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

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

{ # Agentspace only. Request message for UndeleteWorkforcePoolProviderScimToken.
}

  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 token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests.
  "displayName": "A String", # Optional. Agentspace only. The display name of the SCIM token. Cannot exceed 32 characters.
  "name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
  "securityToken": "A String", # Output only. Agentspace only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
  "state": "A String", # Output only. Agentspace only. The state of the token.
}