[ aws . iot ]

describe-default-authorizer

Description

Describes the default authorizer.

Requires permission to access the DescribeDefaultAuthorizer action.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-default-authorizer
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To get information about the default custom authorizer

The following describe-default-authorizer example displays details for the default custom authorizer.

aws iot describe-default-authorizer

Output:

{
    "authorizerName": "CustomAuthorizer",
    "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer"
}

For more information, see DescribeDefaultAuthorizer in the AWS IoT API Reference.

Output

authorizerDescription -> (structure)

The default authorizer’s description.

authorizerName -> (string)

The authorizer name.

authorizerArn -> (string)

The authorizer ARN.

authorizerFunctionArn -> (string)

The authorizer’s Lambda function ARN.

tokenKeyName -> (string)

The key used to extract the token from the HTTP headers.

tokenSigningPublicKeys -> (map)

The public keys used to validate the token signature returned by your custom authentication service.

key -> (string)

value -> (string)

status -> (string)

The status of the authorizer.

creationDate -> (timestamp)

The UNIX timestamp of when the authorizer was created.

lastModifiedDate -> (timestamp)

The UNIX timestamp of when the authorizer was last updated.

signingDisabled -> (boolean)

Specifies whether IoT validates the token signature in an authorization request.

enableCachingForHttp -> (boolean)

When true , the result from the authorizer’s Lambda function is cached for the time specified in refreshAfterInSeconds . The cached result is used while the device reuses the same HTTP connection.