1. class
  2. Google
  3. \
  4. Service
  5. \
  6. CloudIdentity
  7. \
  8. Resource
  9. \
  10. InboundSamlSsoProfilesIdpCredentials

InboundSamlSsoProfilesIdpCredentials

class InboundSamlSsoProfilesIdpCredentials extends Resource (View source)

The "idpCredentials" collection of methods.

Typical usage is:

 $cloudidentityService = new Google\Service\CloudIdentity(...);
 $idpCredentials = $cloudidentityService->inboundSamlSsoProfiles_idpCredentials;

Methods

Operation
add(string $parent, AddIdpCredentialRequest $postBody, array $optParams = [])

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".

Operation
delete(string $name, array $optParams = [])

Deletes an IdpCredential. (idpCredentials.delete)

IdpCredential
get(string $name, array $optParams = [])

Gets an IdpCredential. (idpCredentials.get)

ListIdpCredentialsResponse
listInboundSamlSsoProfilesIdpCredentials(string $parent, array $optParams = [])

Returns a list of IdpCredentials in an InboundSamlSsoProfile.

Details

at line 50
Operation add(string $parent, AddIdpCredentialRequest $postBody, array $optParams = [])

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".

(idpCredentials.add)

Parameters

string $parent

Required. The InboundSamlSsoProfile that owns the IdpCredential. Format: inboundSamlSsoProfiles/{sso_profile_id}
AddIdpCredentialRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 67
Operation delete(string $name, array $optParams = [])

Deletes an IdpCredential. (idpCredentials.delete)

Parameters

string $name

Required. The resource name of the IdpCredential to delete. Format: inboundSamlSsoProfiles/{sso_profile_id}/idpCredentials/{idp_credential_id}
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 84
IdpCredential get(string $name, array $optParams = [])

Gets an IdpCredential. (idpCredentials.get)

Parameters

string $name

Required. The resource name of the IdpCredential to retrieve. Format: inboundSamlSsoProfiles/{sso_profile_id}/idpCredentials/{idp_credential_id}
array $optParams

Optional parameters.

Return Value

IdpCredential

Exceptions

Exception

at line 107
ListIdpCredentialsResponse listInboundSamlSsoProfilesIdpCredentials(string $parent, array $optParams = [])

Returns a list of IdpCredentials in an InboundSamlSsoProfile.

(idpCredentials.listInboundSamlSsoProfilesIdpCredentials)

Parameters

string $parent

Required. The parent, which owns this collection of IdpCredentials. Format: inboundSamlSsoProfiles/{sso_profile_id}
array $optParams

Optional parameters.

Return Value

ListIdpCredentialsResponse

Exceptions

Exception