inbound_oidc_sso_profiles

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

Overview

Name	inbound_oidc_sso_profiles
Type	Resource
Id	google.cloudidentity.inbound_oidc_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 OIDC SSO profile.
customer	string	Immutable. The customer. For example: customers/C0123abc.
displayName	string	Human-readable name of the OIDC SSO profile.
idpConfig	object	OIDC identity provider configuration. (id: OidcIdpConfig)
rpConfig	object	OIDC relying party (RP) configuration for this OIDC SSO profile. These are the RP details provided by Google that should be configured on the corresponding identity provider. (id: OidcRpConfig)

list

Successful response

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	inboundOidcSsoProfilesId		Gets an InboundOidcSsoProfile.
list	select		filter, pageSize, pageToken	Lists InboundOidcSsoProfile objects for a Google enterprise customer.
create	insert			Creates an InboundOidcSsoProfile 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	inboundOidcSsoProfilesId	updateMask	Updates an InboundOidcSsoProfile. 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	inboundOidcSsoProfilesId		Deletes an InboundOidcSsoProfile.

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
inboundOidcSsoProfilesId	string
filter	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets an InboundOidcSsoProfile.

SELECT
name,
customer,
displayName,
idpConfig,
rpConfig
FROM google.cloudidentity.inbound_oidc_sso_profiles
WHERE inboundOidcSsoProfilesId = '{{ inboundOidcSsoProfilesId }}' -- required;

list

Lists InboundOidcSsoProfile objects for a Google enterprise customer.

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

INSERT examples

create

Creates an InboundOidcSsoProfile 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_oidc_sso_profiles (
data__customer,
data__displayName,
data__idpConfig,
data__rpConfig
)
SELECT 
'{{ customer }}',
'{{ displayName }}',
'{{ idpConfig }}',
'{{ rpConfig }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: inbound_oidc_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 OIDC SSO profile.
        
    - name: idpConfig
      value: object
      description: >
        OIDC identity provider configuration.
        
    - name: rpConfig
      value: object
      description: >
        OIDC relying party (RP) configuration for this OIDC SSO profile. These are the RP details provided by Google that should be configured on the corresponding identity provider.
        

UPDATE examples

patch

Updates an InboundOidcSsoProfile. 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_oidc_sso_profiles
SET 
data__customer = '{{ customer }}',
data__displayName = '{{ displayName }}',
data__idpConfig = '{{ idpConfig }}',
data__rpConfig = '{{ rpConfig }}'
WHERE 
inboundOidcSsoProfilesId = '{{ inboundOidcSsoProfilesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes an InboundOidcSsoProfile.

DELETE FROM google.cloudidentity.inbound_oidc_sso_profiles
WHERE inboundOidcSsoProfilesId = '{{ inboundOidcSsoProfilesId }}' --required;