list-saml-providers¶

Description¶

Lists SAML providers in CDP account.

list-saml-providers is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument.

Synopsis¶

  list-saml-providers
[--saml-provider-names <value>]
[--max-items <value>]
[--starting-token <value>]
[--page-size <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--saml-provider-names (array)

The SAML providers names or CRNs to retrieve. If empty all SAML providers will be returned.

Syntax:

"string" "string" ...

--max-items (integer)

The total number of items to return. If the total number of items available is more than the value specified in max-items then a nextToken will be provided in the output that you can use to resume pagination. This nextToken response element should not be used directly outside of the CDP CLI. This option cannnot be combined with the no-paginate CLI option. If no max-items value is specified, then a default value of 100 is used.

--starting-token (string)

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

--page-size (integer)

The size of each page. Generally this does not need to be set and the default page size used is appropriate.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

samlProviders -> (array)

The SAML providers.

item -> (object)

Information used to connect a CDP account to an external identity provider.

crn -> (string)

CRN of the SAML provider in CDP.

creationDate -> (datetime)

The date when this SAML provider record was created.

samlProviderName -> (string)

Name of the SAML provider.

samlProviderId -> (string)

The unique ID of the saml provider.

syncGroupsOnLogin -> (boolean)

Whether users federated with this SAML provider will have their group membership synchronized. Group membership can be passed using the https://cdp.cloudera.com/SAML/Attributes/groups SAML assertion.

generateWorkloadUsernameByEmail -> (boolean)

Whether to generate users’ workload username by email or by identity provider user ID (SAML NameID).

enableScim -> (boolean)

Whether SCIM is enabled on this SAML provider. System for Cross-domain Identity Management (SCIM) version 2.0 is a standard for automating the provisioning of user and group identity information from identity provider to CDP. It is omitted for Cloudera for Government.

Form Factors: public

scimUrl -> (string)

The SCIM URL if SCIM is enabled. It is omitted for Cloudera for Government.

samlMetadataDocument -> (string)

The original metadata that was passed while creating the SAML provider connector. This field will not be set when the SAML provider does not have metadata. This field will not be set for list-saml-providers API response.

cdpSpMetadata -> (string)

The Service Provider SAML metadata specific to this CDP SAML provider. This field will only be set for create-saml-provider and describe-saml-provider API calls.

nextToken -> (string)

The token to use when requesting the next set of results. If not present, there are no additional results.

Form Factors¶

public, private