idp_credentials

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

Overview

Name	idp_credentials
Type	Resource
Id	google.cloudidentity.idp_credentials

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. Resource name of the credential.
dsaKeyInfo	object	Output only. Information of a DSA public key. (id: DsaPublicKeyInfo)
rsaKeyInfo	object	Output only. Information of a RSA public key. (id: RsaPublicKeyInfo)
updateTime	string (google-datetime)	Output only. Time when the IdpCredential was last updated.

list

Successful response

Name	Datatype	Description
name	string	Output only. Resource name of the credential.
dsaKeyInfo	object	Output only. Information of a DSA public key. (id: DsaPublicKeyInfo)
rsaKeyInfo	object	Output only. Information of a RSA public key. (id: RsaPublicKeyInfo)
updateTime	string (google-datetime)	Output only. Time when the IdpCredential was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	inboundSamlSsoProfilesId, idpCredentialsId		Gets an IdpCredential.
list	select	inboundSamlSsoProfilesId	pageSize, pageToken	Returns a list of IdpCredentials in an InboundSamlSsoProfile.
add	insert	inboundSamlSsoProfilesId		Adds an IdpCredential. Up to 2 credentials are allowed. 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, idpCredentialsId		Deletes an IdpCredential.

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
idpCredentialsId	string
inboundSamlSsoProfilesId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets an IdpCredential.

SELECT
name,
dsaKeyInfo,
rsaKeyInfo,
updateTime
FROM google.cloudidentity.idp_credentials
WHERE inboundSamlSsoProfilesId = '{{ inboundSamlSsoProfilesId }}' -- required
AND idpCredentialsId = '{{ idpCredentialsId }}' -- required;

list

Returns a list of IdpCredentials in an InboundSamlSsoProfile.

SELECT
name,
dsaKeyInfo,
rsaKeyInfo,
updateTime
FROM google.cloudidentity.idp_credentials
WHERE inboundSamlSsoProfilesId = '{{ inboundSamlSsoProfilesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

add

Adds an IdpCredential. Up to 2 credentials are allowed. 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.idp_credentials (
data__pemData,
inboundSamlSsoProfilesId
)
SELECT 
'{{ pemData }}',
'{{ inboundSamlSsoProfilesId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: idp_credentials
  props:
    - name: inboundSamlSsoProfilesId
      value: string
      description: Required parameter for the idp_credentials resource.
    - name: pemData
      value: string
      description: >
        PEM encoded x509 certificate containing the public key for verifying IdP signatures.
        

DELETE examples

delete

Deletes an IdpCredential.

DELETE FROM google.cloudidentity.idp_credentials
WHERE inboundSamlSsoProfilesId = '{{ inboundSamlSsoProfilesId }}' --required
AND idpCredentialsId = '{{ idpCredentialsId }}' --required;