inbound_saml_sso_profiles

Creates, updates, deletes, gets or lists an inbound_saml_sso_profiles resource.

Overview

Name	inbound_saml_sso_profiles
Type	Resource
Id	google.cloudidentity.inbound_saml_sso_profiles

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. Resource name of the SAML SSO profile.
customer	string	Immutable. The customer. For example: customers/C0123abc.
displayName	string	Human-readable name of the SAML SSO profile.
idpConfig	object	SAML identity provider configuration. (id: SamlIdpConfig)
spConfig	object	SAML service provider configuration for this SAML SSO profile. These are the service provider details provided by Google that should be configured on the corresponding identity provider. (id: SamlSpConfig)

list

Successful response

Name	Datatype	Description
name	string	Output only. Resource name of the SAML SSO profile.
customer	string	Immutable. The customer. For example: customers/C0123abc.
displayName	string	Human-readable name of the SAML SSO profile.
idpConfig	object	SAML identity provider configuration. (id: SamlIdpConfig)
spConfig	object	SAML service provider configuration for this SAML SSO profile. These are the service provider details provided by Google that should be configured on the corresponding identity provider. (id: SamlSpConfig)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	inboundSamlSsoProfilesId		Gets an InboundSamlSsoProfile.
list	select		filter, pageSize, pageToken	Lists InboundSamlSsoProfiles for a customer.
create	insert			Creates an InboundSamlSsoProfile for a customer. When the target customer has enabled Multi-party approval for sensitive actions, the Operation in the response will have "done": false, it will not have a response, and the metadata will have "state": "awaiting-multi-party-approval".
patch	update	inboundSamlSsoProfilesId	updateMask	Updates an InboundSamlSsoProfile. When the target customer has enabled Multi-party approval for sensitive actions, the Operation in the response will have "done": false, it will not have a response, and the metadata will have "state": "awaiting-multi-party-approval".
delete	delete	inboundSamlSsoProfilesId		Deletes an InboundSamlSsoProfile.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
inboundSamlSsoProfilesId	string
filter	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets an InboundSamlSsoProfile.

SELECT
name,
customer,
displayName,
idpConfig,
spConfig
FROM google.cloudidentity.inbound_saml_sso_profiles
WHERE inboundSamlSsoProfilesId = '{{ inboundSamlSsoProfilesId }}' -- required;

list

Lists InboundSamlSsoProfiles for a customer.

SELECT
name,
customer,
displayName,
idpConfig,
spConfig
FROM google.cloudidentity.inbound_saml_sso_profiles
WHERE filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

create

Creates an InboundSamlSsoProfile for a customer. When the target customer has enabled Multi-party approval for sensitive actions, the Operation in the response will have "done": false, it will not have a response, and the metadata will have "state": "awaiting-multi-party-approval".

INSERT INTO google.cloudidentity.inbound_saml_sso_profiles (
data__customer,
data__displayName,
data__idpConfig,
data__spConfig
)
SELECT 
'{{ customer }}',
'{{ displayName }}',
'{{ idpConfig }}',
'{{ spConfig }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: inbound_saml_sso_profiles
  props:
    - name: customer
      value: string
      description: >
        Immutable. The customer. For example: `customers/C0123abc`.
        
    - name: displayName
      value: string
      description: >
        Human-readable name of the SAML SSO profile.
        
    - name: idpConfig
      value: object
      description: >
        SAML identity provider configuration.
        
    - name: spConfig
      value: object
      description: >
        SAML service provider configuration for this SAML SSO profile. These are the service provider details provided by Google that should be configured on the corresponding identity provider.
        

UPDATE examples

patch

Updates an InboundSamlSsoProfile. When the target customer has enabled Multi-party approval for sensitive actions, the Operation in the response will have "done": false, it will not have a response, and the metadata will have "state": "awaiting-multi-party-approval".

UPDATE google.cloudidentity.inbound_saml_sso_profiles
SET 
data__customer = '{{ customer }}',
data__displayName = '{{ displayName }}',
data__idpConfig = '{{ idpConfig }}',
data__spConfig = '{{ spConfig }}'
WHERE 
inboundSamlSsoProfilesId = '{{ inboundSamlSsoProfilesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes an InboundSamlSsoProfile.

DELETE FROM google.cloudidentity.inbound_saml_sso_profiles
WHERE inboundSamlSsoProfilesId = '{{ inboundSamlSsoProfilesId }}' --required;