Close httplib2 connections.
create(parent, body=None, workforcePoolProviderScimTokenId=None, x__xgafv=None)
Creates a new WorkforcePoolProviderScimToken in a WorkforcePoolProviderScimTenant. You cannot reuse the name of a deleted SCIM token until 30 days after deletion.
Deletes a WorkforcePoolProviderScimToken. You can undelete a scim token for 30 days. After 30 days, deletion is permanent. You cannot update deleted scim tokens. However, you can view and list them.
Gets an individual WorkforcePoolProviderScimToken.
list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)
Lists all non-deleted WorkforcePoolProviderScimTokenss in a WorkforcePoolProviderScimTenant. If `show_deleted` is set to `true`, then deleted SCIM tokens are also listed.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates an existing WorkforcePoolProviderScimToken.
undelete(name, body=None, x__xgafv=None)
Undeletes a WorkforcePoolProviderScimToken, as long as it was deleted fewer than 30 days ago.
close()
Close httplib2 connections.
create(parent, body=None, workforcePoolProviderScimTokenId=None, x__xgafv=None)
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. 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:
{ # Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning requests.
"displayName": "A String", # Optional. The user-specified display name of the scim token. Cannot exceed 32 characters.
"name": "A String", # Identifier. 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. The token string. Provide this to the IdP for authentication. Will be set only during creation.
"state": "A String", # Output only. The state of the token.
}
workforcePoolProviderScimTokenId: string, Required. 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 this 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:
{ # Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning requests.
"displayName": "A String", # Optional. The user-specified display name of the scim token. Cannot exceed 32 characters.
"name": "A String", # Identifier. 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. The token string. Provide this to the IdP for authentication. Will be set only during creation.
"state": "A String", # Output only. The state of the token.
}
delete(name, x__xgafv=None)
Deletes a WorkforcePoolProviderScimToken. You can undelete a scim token for 30 days. After 30 days, deletion is permanent. You cannot update deleted scim tokens. However, you can view and list them.
Args:
name: string, Required. 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:
{ # Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning requests.
"displayName": "A String", # Optional. The user-specified display name of the scim token. Cannot exceed 32 characters.
"name": "A String", # Identifier. 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. The token string. Provide this to the IdP for authentication. Will be set only during creation.
"state": "A String", # Output only. The state of the token.
}
get(name, x__xgafv=None)
Gets an individual WorkforcePoolProviderScimToken.
Args:
name: string, Required. 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:
{ # Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning requests.
"displayName": "A String", # Optional. The user-specified display name of the scim token. Cannot exceed 32 characters.
"name": "A String", # Identifier. 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. The token string. Provide this to the IdP for authentication. Will be set only during creation.
"state": "A String", # Output only. The state of the token.
}
list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)
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. The parent to list scim tokens. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}' (required)
pageSize: integer, Optional. The maximum number of scim tokens to return. If unspecified, at most 2 scim tokens will be returned.
pageToken: string, Optional. A page token, received from a previous `ListWorkforcePoolProviderScimTokens` call. Provide this to retrieve the subsequent page.
showDeleted: boolean, Optional. 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:
{ # Response message for ListWorkforcePoolProviderScimTokens.
"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.
"workforcePoolProviderScimTokens": [ # Output only. A list of scim tokens.
{ # Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning requests.
"displayName": "A String", # Optional. The user-specified display name of the scim token. Cannot exceed 32 characters.
"name": "A String", # Identifier. 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. The token string. Provide this to the IdP for authentication. Will be set only during creation.
"state": "A String", # Output 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)
Updates an existing WorkforcePoolProviderScimToken.
Args:
name: string, Identifier. 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:
{ # Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning requests.
"displayName": "A String", # Optional. The user-specified display name of the scim token. Cannot exceed 32 characters.
"name": "A String", # Identifier. 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. The token string. Provide this to the IdP for authentication. Will be set only during creation.
"state": "A String", # Output only. The state of the token.
}
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 token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning requests.
"displayName": "A String", # Optional. The user-specified display name of the scim token. Cannot exceed 32 characters.
"name": "A String", # Identifier. 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. The token string. Provide this to the IdP for authentication. Will be set only during creation.
"state": "A String", # Output only. The state of the token.
}
undelete(name, body=None, x__xgafv=None)
Undeletes a WorkforcePoolProviderScimToken, as long as it was deleted fewer than 30 days ago.
Args:
name: string, Required. 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:
{ # 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:
{ # Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning requests.
"displayName": "A String", # Optional. The user-specified display name of the scim token. Cannot exceed 32 characters.
"name": "A String", # Identifier. 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. The token string. Provide this to the IdP for authentication. Will be set only during creation.
"state": "A String", # Output only. The state of the token.
}