atlas api federatedAuthentication revokeJwksFromIdentityProvider
On this page
experimental: Revokes the JWKS tokens from the requested OIDC identity provider.
To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. Note: Revoking your JWKS tokens immediately refreshes your IdP public keys from all your Atlas clusters, invalidating previously signed access tokens and logging out all users. You may need to restart your MongoDB clients. All organizations connected to the identity provider will be affected. To learn more, see Configure OIDC Authorization. This command is invoking the endpoint with OperationID: 'revokeJwksFromIdentityProvider'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/revokeJwksFromIdentityProvider
Syntax
atlas api federatedAuthentication revokeJwksFromIdentityProvider [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--envelope | false | flag that indicates whether Application wraps the response in an envelope JSON object | |
--federationSettingsId | string | true | unique 24-hexadecimal digit string that identifies your federation |
-h, --help | false | help for revokeJwksFromIdentityProvider | |
--identityProviderId | string | true | unique 24-hexadecimal digit string that identifies the identity provider to connect |
--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) |
--version | string | false | api version to use when calling the api call [options: "2023-11-15"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-11-15". |
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. |