Skip to main content

inbound_sso_assignments

Creates, updates, deletes, gets or lists a inbound_sso_assignments resource.

Overview

Nameinbound_sso_assignments
TypeResource
Idgoogle.cloudidentity.inbound_sso_assignments

Fields

NameDatatypeDescription
namestringOutput only. Resource name of the Inbound SSO Assignment.
customerstringImmutable. The customer. For example: customers/C0123abc.
rankintegerMust be zero (which is the default value so it can be omitted) for assignments with target_org_unit set and must be greater-than-or-equal-to one for assignments with target_group set.
samlSsoInfoobjectDetails that are applicable when sso_mode == SAML_SSO.
signInBehaviorobjectControls sign-in behavior.
ssoModestringInbound SSO behavior.
targetGroupstringImmutable. Must be of the form groups/{group}.
targetOrgUnitstringImmutable. Must be of the form orgUnits/{org_unit}.

Methods

NameAccessible byRequired ParamsDescription
getSELECTinboundSsoAssignmentsIdGets an InboundSsoAssignment.
listSELECTLists the InboundSsoAssignments for a Customer.
createINSERTCreates an InboundSsoAssignment for users and devices in a Customer under a given Group or OrgUnit.
deleteDELETEinboundSsoAssignmentsIdDeletes an InboundSsoAssignment. To disable SSO, Create (or Update) an assignment that has sso_mode == SSO_OFF.
patchUPDATEinboundSsoAssignmentsIdUpdates 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.

SELECT examples

Lists the InboundSsoAssignments for a Customer.

SELECT
name,
customer,
rank,
samlSsoInfo,
signInBehavior,
ssoMode,
targetGroup,
targetOrgUnit
FROM google.cloudidentity.inbound_sso_assignments
;

INSERT example

Use the following StackQL query and manifest file to create a new inbound_sso_assignments resource.

/*+ create */
INSERT INTO google.cloudidentity.inbound_sso_assignments (
targetGroup,
targetOrgUnit,
customer,
rank,
ssoMode,
samlSsoInfo,
signInBehavior
)
SELECT
'{{ targetGroup }}',
'{{ targetOrgUnit }}',
'{{ customer }}',
'{{ rank }}',
'{{ ssoMode }}',
'{{ samlSsoInfo }}',
'{{ signInBehavior }}'
;

UPDATE example

Updates a inbound_sso_assignments resource.

/*+ update */
UPDATE google.cloudidentity.inbound_sso_assignments
SET
targetGroup = '{{ targetGroup }}',
targetOrgUnit = '{{ targetOrgUnit }}',
customer = '{{ customer }}',
rank = '{{ rank }}',
ssoMode = '{{ ssoMode }}',
samlSsoInfo = '{{ samlSsoInfo }}',
signInBehavior = '{{ signInBehavior }}'
WHERE
inboundSsoAssignmentsId = '{{ inboundSsoAssignmentsId }}';

DELETE example

Deletes the specified inbound_sso_assignments resource.

/*+ delete */
DELETE FROM google.cloudidentity.inbound_sso_assignments
WHERE inboundSsoAssignmentsId = '{{ inboundSsoAssignmentsId }}';