AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . wickr ]

register-oidc-config

Description

Registers and saves an OpenID Connect (OIDC) configuration for a Wickr network, enabling Single Sign-On (SSO) authentication through an identity provider.

See also: AWS API Documentation

Synopsis

  register-oidc-config
--network-id <value>
--company-id <value>
[--custom-username <value>]
[--extra-auth-params <value>]
--issuer <value>
--scopes <value>
[--secret <value>]
[--sso-token-buffer-minutes <value>]
[--user-id <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--network-id (string)

The ID of the Wickr network for which OIDC will be configured.

--company-id (string)

Custom identifier your end users will use to sign in with SSO.

--custom-username (string)

A custom field mapping to extract the username from the OIDC token (optional).

Note

The customUsername is only required if you use something other than email as the username field.

--extra-auth-params (string)

Additional authentication parameters to include in the OIDC flow (optional).

--issuer (string)

The issuer URL of the OIDC provider (e.g., ‘https://login.example.com’).

--scopes (string)

The OAuth scopes to request from the OIDC provider (e.g., ‘openid profile email’).

--secret (string)

The client secret for authenticating with the OIDC provider (optional).

--sso-token-buffer-minutes (integer)

The buffer time in minutes before the SSO token expires to refresh it (optional).

--user-id (string)

Unique identifier provided by your identity provider to authenticate the access request. Also referred to as clientID.

--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. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

applicationName -> (string)

The name of the registered OIDC application.

clientId -> (string)

The OAuth client ID assigned to the application.

companyId -> (string)

Custom identifier your end users will use to sign in with SSO.

scopes -> (string)

The OAuth scopes configured for the application.

issuer -> (string)

The issuer URL of the OIDC provider.

clientSecret -> (string)

The OAuth client secret for the application.

secret -> (string)

The client secret for authenticating with the OIDC provider.

redirectUrl -> (string)

The redirect URL configured for the OAuth flow.

userId -> (string)

The claim field being used as the user identifier.

customUsername -> (string)

The custom field mapping used for extracting the username.

caCertificate -> (string)

The CA certificate used for secure communication with the OIDC provider.

applicationId -> (integer)

The unique identifier for the registered OIDC application.

ssoTokenBufferMinutes -> (integer)

The buffer time in minutes before the SSO token expires.

extraAuthParams -> (string)

The additional authentication parameters configured for the OIDC flow.