2022-10-01
▼ ▲ cloudidentity.inboundSamlSsoProfiles.idpCredentials.get
Path : v1beta1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets an IdpCredential.
Parameter Order : name
Flat Path : v1beta1/inboundSamlSsoProfiles/{inboundSamlSsoProfilesId}/idpCredentials/{idpCredentialsId}
Parameters :
name
Type : string
Description : Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the IdpCredential to retrieve. Format: `inboundSamlSsoProfiles/{sso_profile_id}/idpCredentials/{idp_credential_id}`
Pattern : ^inboundSamlSsoProfiles/[^/]+/idpCredentials/[^/]+$
Location : path
Required : Yes
HTTP Method : GET
▼ ▲ cloudidentity.inboundSamlSsoProfiles.idpCredentials.add
Path : v1beta1/{+parent}/idpCredentials:add
HTTP Method : POST
Description : Adds an IdpCredential. Up to 2 credentials are allowed.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Parameters :
parent
Pattern : ^inboundSamlSsoProfiles/[^/]+$
Description : Required. The InboundSamlSsoProfile that owns the IdpCredential. Format: `inboundSamlSsoProfiles/{sso_profile_id}`
Required : Yes
Location : path
Type : string
Flat Path : v1beta1/inboundSamlSsoProfiles/{inboundSamlSsoProfilesId}/idpCredentials:add
▼ ▲ cloudidentity.inboundSamlSsoProfiles.idpCredentials.list
Parameter Order : parent
HTTP Method : GET
Flat Path : v1beta1/inboundSamlSsoProfiles/{inboundSamlSsoProfilesId}/idpCredentials
Description : Returns a list of IdpCredentials in an InboundSamlSsoProfile.
Parameters :
parent
Type : string
Location : path
Required : Yes
Description : Required. The parent, which owns this collection of `IdpCredential`s. Format: `inboundSamlSsoProfiles/{sso_profile_id}`
Pattern : ^inboundSamlSsoProfiles/[^/]+$
pageToken
Description : A page token, received from a previous `ListIdpCredentials` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdpCredentials` must match the call that provided the page token.
Type : string
Location : query
pageSize
Description : The maximum number of `IdpCredential`s to return. The service may return fewer than this value.
Location : query
Type : integer
Format : int32
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+parent}/idpCredentials
▼ ▲ cloudidentity.inboundSamlSsoProfiles.idpCredentials.delete
Parameters :
name
Location : path
Type : string
Pattern : ^inboundSamlSsoProfiles/[^/]+/idpCredentials/[^/]+$
Description : Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the IdpCredential to delete. Format: `inboundSamlSsoProfiles/{sso_profile_id}/idpCredentials/{idp_credential_id}`
Required : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
Parameter Order : name
Description : Deletes an IdpCredential.
Flat Path : v1beta1/inboundSamlSsoProfiles/{inboundSamlSsoProfilesId}/idpCredentials/{idpCredentialsId}
Path : v1beta1/{+name}
▼ ▲ cloudidentity.inboundSamlSsoProfiles.patch
Flat Path : v1beta1/inboundSamlSsoProfiles/{inboundSamlSsoProfilesId}
Parameter Order : name
Description : Updates an InboundSamlSsoProfile.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
updateMask
Type : string
Description : Required. The list of fields to be updated.
Location : query
Format : google-fieldmask
name
Type : string
Description : Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the SAML SSO profile.
Location : path
Pattern : ^inboundSamlSsoProfiles/[^/]+$
Required : Yes
Path : v1beta1/{+name}
HTTP Method : PATCH
▼ ▲ cloudidentity.inboundSamlSsoProfiles.create
Description : Creates an InboundSamlSsoProfile for a customer.
Path : v1beta1/inboundSamlSsoProfiles
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/inboundSamlSsoProfiles
▼ ▲ cloudidentity.inboundSamlSsoProfiles.delete
Flat Path : v1beta1/inboundSamlSsoProfiles/{inboundSamlSsoProfilesId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+name}
Parameters :
name
Required : Yes
Pattern : ^inboundSamlSsoProfiles/[^/]+$
Type : string
Location : path
Description : Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the InboundSamlSsoProfile to delete. Format: `inboundSamlSsoProfiles/{sso_profile_id}`
Parameter Order : name
Description : Deletes an InboundSamlSsoProfile.
HTTP Method : DELETE
▼ ▲ cloudidentity.inboundSamlSsoProfiles.list
Path : v1beta1/inboundSamlSsoProfiles
Flat Path : v1beta1/inboundSamlSsoProfiles
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists InboundSamlSsoProfiles for a customer.
HTTP Method : GET
Parameters :
pageToken
Type : string
Location : query
Description : A page token, received from a previous `ListInboundSamlSsoProfiles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListInboundSamlSsoProfiles` must match the call that provided the page token.
filter
Location : query
Type : string
Description : A CEL expression to filter the results. The only currently-supported filter is filtering by customer. For example: `customer==customers/C0123abc`. Omitting the filter or specifying a filter of `customer==customers/my_customer` will return the profiles for the customer that the caller (authenticated user) belongs to.
pageSize
Location : query
Format : int32
Type : integer
Description : The maximum number of InboundSamlSsoProfiles to return. The service may return fewer than this value. If omitted (or defaulted to zero) the server will use a sensible default. This default may change over time. The maximum allowed value is 100, though requests with page_size greater than that will be silently interpreted as having this maximum value. This may increase in the futue.
▼ ▲ cloudidentity.inboundSamlSsoProfiles.get
Description : Gets an InboundSamlSsoProfile.
Flat Path : v1beta1/inboundSamlSsoProfiles/{inboundSamlSsoProfilesId}
Parameters :
name
Location : path
Description : Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the InboundSamlSsoProfile to get. Format: `inboundSamlSsoProfiles/{sso_profile_id}`
Type : string
Required : Yes
Pattern : ^inboundSamlSsoProfiles/[^/]+$
HTTP Method : GET
Path : v1beta1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ cloudidentity.inboundSsoAssignments.list
HTTP Method : GET
Parameters :
filter
Type : string
Location : query
Description : A CEL expression to filter the results. The only currently-supported filter is filtering by customer. For example: `customer==customers/C0123abc`. Omitting the filter or specifying a filter of `customer==customers/my_customer` will return the assignments for the customer that the caller (authenticated user) belongs to.
pageSize
Location : query
Format : int32
Type : integer
Description : The maximum number of assignments to return. The service may return fewer than this value. If omitted (or defaulted to zero) the server will use a sensible default. This default may change over time. The maximum allowed value is 100, though requests with page_size greater than that will be silently interpreted as having this maximum value. This may increase in the futue.
pageToken
Description : A page token, received from a previous `ListInboundSsoAssignments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListInboundSsoAssignments` must match the call that provided the page token.
Type : string
Location : query
Flat Path : v1beta1/inboundSsoAssignments
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/inboundSsoAssignments
Description : Lists the InboundSsoAssignments for a `Customer`.
▼ ▲ cloudidentity.inboundSsoAssignments.create
HTTP Method : POST
Flat Path : v1beta1/inboundSsoAssignments
Description : Creates an InboundSsoAssignment for users and devices in a `Customer` under a given `Group` or `OrgUnit`.
Path : v1beta1/inboundSsoAssignments
▼ ▲ cloudidentity.inboundSsoAssignments.get
HTTP Method : GET
Description : Gets an InboundSsoAssignment.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+name}
Flat Path : v1beta1/inboundSsoAssignments/{inboundSsoAssignmentsId}
Parameters :
name
Pattern : ^inboundSsoAssignments/[^/]+$
Required : Yes
Location : path
Description : Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the InboundSsoAssignment to fetch. Format: `inboundSsoAssignments/{assignment}`
Type : string
Parameter Order : name
▼ ▲ cloudidentity.inboundSsoAssignments.delete
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an InboundSsoAssignment. To disable SSO, Create (or Update) an assignment that has `sso_mode` == `SSO_OFF`.
Flat Path : v1beta1/inboundSsoAssignments/{inboundSsoAssignmentsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the InboundSsoAssignment to delete. Format: `inboundSsoAssignments/{assignment}`
Location : path
Type : string
Required : Yes
Pattern : ^inboundSsoAssignments/[^/]+$
Path : v1beta1/{+name}
▼ ▲ cloudidentity.inboundSsoAssignments.patch
Description : Updates an InboundSsoAssignment. The body of this request is the `inbound_sso_assignment` field and the `update_mask` is relative to that. For example: a PATCH to `/v1beta1/inboundSsoAssignments/0abcdefg1234567&update_mask=rank` with a body of `{ "rank": 1 }` moves that (presumably group-targeted) SSO assignment to the highest priority and shifts any other group-targeted assignments down in priority.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Description : Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Inbound SSO Assignment.
Pattern : ^inboundSsoAssignments/[^/]+$
Required : Yes
Location : path
updateMask
Location : query
Format : google-fieldmask
Type : string
Description : Required. The list of fields to be updated.
HTTP Method : PATCH
Parameter Order : name
Path : v1beta1/{+name}
Flat Path : v1beta1/inboundSsoAssignments/{inboundSsoAssignmentsId}