2023-01-19
▼ ▲ cloudidentity.inboundSamlSsoProfiles.idpCredentials.get
Parameters:
name
Location: path
Pattern: ^inboundSamlSsoProfiles/[^/]+/idpCredentials/[^/]+$
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}`
Required: Yes
Parameter Order: name
HTTP Method: GET
Flat Path: v1/inboundSamlSsoProfiles/{inboundSamlSsoProfilesId}/idpCredentials/{idpCredentialsId}
Path: v1/{+name}
Description: Gets an IdpCredential.
▼ ▲ cloudidentity.inboundSamlSsoProfiles.idpCredentials.delete
Parameters:
name
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}`
Location: path
Pattern: ^inboundSamlSsoProfiles/[^/]+/idpCredentials/[^/]+$
Type: string
Required: Yes
Path: v1/{+name}
Flat Path: v1/inboundSamlSsoProfiles/{inboundSamlSsoProfilesId}/idpCredentials/{idpCredentialsId}
HTTP Method: DELETE
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes an IdpCredential.
▼ ▲ cloudidentity.inboundSamlSsoProfiles.idpCredentials.add
Parameters:
parent
Location: path
Pattern: ^inboundSamlSsoProfiles/[^/]+$
Type: string
Description: Required. The InboundSamlSsoProfile that owns the IdpCredential. Format: `inboundSamlSsoProfiles/{sso_profile_id}`
Required: Yes
Description: Adds an IdpCredential. Up to 2 credentials are allowed.
Flat Path: v1/inboundSamlSsoProfiles/{inboundSamlSsoProfilesId}/idpCredentials:add
HTTP Method: POST
Path: v1/{+parent}/idpCredentials:add
Parameter Order: parent
▼ ▲ cloudidentity.inboundSamlSsoProfiles.idpCredentials.list
Path: v1/{+parent}/idpCredentials
Parameters:
parent
Type: string
Description: Required. The parent, which owns this collection of `IdpCredential`s. Format: `inboundSamlSsoProfiles/{sso_profile_id}`
Required: Yes
Pattern: ^inboundSamlSsoProfiles/[^/]+$
Location: path
pageSize
Location: query
Format: int32
Type: integer
Description: The maximum number of `IdpCredential`s to return. The service may return fewer than this value.
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.
Location: query
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/inboundSamlSsoProfiles/{inboundSamlSsoProfilesId}/idpCredentials
Parameter Order: parent
Description: Returns a list of IdpCredentials in an InboundSamlSsoProfile.
HTTP Method: GET
▼ ▲ cloudidentity.inboundSamlSsoProfiles.get
Path: v1/{+name}
Parameter Order: name
HTTP Method: GET
Description: Gets an InboundSamlSsoProfile.
Flat Path: v1/inboundSamlSsoProfiles/{inboundSamlSsoProfilesId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^inboundSamlSsoProfiles/[^/]+$
Type: string
Required: Yes
Description: Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the InboundSamlSsoProfile to get. Format: `inboundSamlSsoProfiles/{sso_profile_id}`
Location: path
▼ ▲ cloudidentity.inboundSamlSsoProfiles.delete
Path: v1/{+name}
Flat Path: v1/inboundSamlSsoProfiles/{inboundSamlSsoProfilesId}
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^inboundSamlSsoProfiles/[^/]+$
Type: string
Description: Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the InboundSamlSsoProfile to delete. Format: `inboundSamlSsoProfiles/{sso_profile_id}`
Location: path
Required: Yes
Description: Deletes an InboundSamlSsoProfile.
Parameter Order: name
▼ ▲ cloudidentity.inboundSamlSsoProfiles.list
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.
pageSize
Location: query
Format: int32
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. Requests with page_size greater than that will be silently interpreted as having this maximum value.
Type: integer
filter
Location: query
Description: A [Common Expression Language](https://github.com/google/cel-spec) 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.
Type: string
Path: v1/inboundSamlSsoProfiles
HTTP Method: GET
Flat Path: v1/inboundSamlSsoProfiles
Description: Lists InboundSamlSsoProfiles for a customer.
▼ ▲ cloudidentity.inboundSamlSsoProfiles.create
Description: Creates an InboundSamlSsoProfile for a customer.
Path: v1/inboundSamlSsoProfiles
HTTP Method: POST
Flat Path: v1/inboundSamlSsoProfiles
▼ ▲ cloudidentity.inboundSamlSsoProfiles.patch
Flat Path: v1/inboundSamlSsoProfiles/{inboundSamlSsoProfilesId}
Parameter Order: name
Description: Updates an InboundSamlSsoProfile.
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PATCH
Parameters:
updateMask
Location: query
Format: google-fieldmask
Type: string
Description: Required. The list of fields to be updated.
name
Pattern: ^inboundSamlSsoProfiles/[^/]+$
Required: Yes
Type: string
Location: path
Description: Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the SAML SSO profile.
▼ ▲ cloudidentity.inboundSsoAssignments.delete
Parameters:
name
Location: path
Required: Yes
Description: Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the InboundSsoAssignment to delete. Format: `inboundSsoAssignments/{assignment}`
Pattern: ^inboundSsoAssignments/[^/]+$
Type: string
Path: v1/{+name}
Flat Path: v1/inboundSsoAssignments/{inboundSsoAssignmentsId}
Description: Deletes an InboundSsoAssignment. To disable SSO, Create (or Update) an assignment that has `sso_mode` == `SSO_OFF`.
HTTP Method: DELETE
Parameter Order: name
▼ ▲ cloudidentity.inboundSsoAssignments.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
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 `/v1/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.
HTTP Method: PATCH
Parameter Order: name
Parameters:
updateMask
Format: google-fieldmask
Description: Required. The list of fields to be updated.
Type: string
Location: query
name
Required: Yes
Description: Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Inbound SSO Assignment.
Pattern: ^inboundSsoAssignments/[^/]+$
Location: path
Type: string
Path: v1/{+name}
Flat Path: v1/inboundSsoAssignments/{inboundSsoAssignmentsId}
▼ ▲ cloudidentity.inboundSsoAssignments.list
Parameters:
filter
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.
Type: string
Location: query
pageSize
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.
Format: int32
Type: integer
Location: query
pageToken
Location: query
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
Flat Path: v1/inboundSsoAssignments
Description: Lists the InboundSsoAssignments for a `Customer`.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/inboundSsoAssignments
HTTP Method: GET
▼ ▲ cloudidentity.inboundSsoAssignments.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/inboundSsoAssignments
Description: Creates an InboundSsoAssignment for users and devices in a `Customer` under a given `Group` or `OrgUnit`.
HTTP Method: POST
Flat Path: v1/inboundSsoAssignments
▼ ▲ cloudidentity.inboundSsoAssignments.get
Flat Path: v1/inboundSsoAssignments/{inboundSsoAssignmentsId}
Description: Gets an InboundSsoAssignment.
Parameter Order: name
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Description: Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the InboundSsoAssignment to fetch. Format: `inboundSsoAssignments/{assignment}`
Required: Yes
Location: path
Pattern: ^inboundSsoAssignments/[^/]+$
Path: v1/{+name}