atlas api federatedAuthentication listIdentityProviders
On this page
Public Preview: please provide feedback at: Returns all identity providers with the provided protocol and type in the specified federation.
If no protocol is specified, only SAML identity providers will be returned. If no idpType is specified, only WORKFORCE identity providers will be returned. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations.
This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listIdentityProviders.
For more information and examples, see the referenced API documentation linked above.
Syntax
atlas api federatedAuthentication listIdentityProviders [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--envelope | envelope | false | Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
--federationSettingsId | string | true | Unique 24-hexadecimal digit string that identifies your federation. |
-h, --help | false | help for listIdentityProviders | |
--idpType | stringArray | false | The types of the target identity providers. |
--itemsPerPage | int | false | Number of items that the response returns per page. |
--output | string | false | preferred api format, can be ["json", go-template] This value defaults to "json". |
--output-file | string | false | file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) |
--pageNum | int | false | Number of the page that displays the current set of the total objects that the response returns. |
--protocol | stringArray | false | The protocols of the target identity providers. |
--version | string | false | api version to use when calling the api call [options: "2023-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01". |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Examples
atlas api federatedAuthentication listIdentityProviders --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e