Authentication Traits

This wiki contains a mapping between Smithy Authentication traits and generated Ruby code.

Authentication traits will not be supported at this time.

authDefinition trait

A meta-trait that marks a trait as an authentication scheme. Traits that are marked with this trait are applied to service shapes to indicate how a client can authenticate with the service.

httpBasicAuth trait

Indicates that a service supports HTTP Basic Authentication as defined in RFC 2617.

httpDigestAuth trait

Indicates that a service supports HTTP Digest Authentication as defined in RFC 2617.

httpBearerAuth trait

Indicates that a service supports HTTP Bearer Authentication as defined in RFC 6750.

httpApiKeyAuth trait

Indicates that a service supports HTTP-specific authentication using an API key sent in a header or query string parameter.

optionalAuth trait

Indicates that an operation MAY be invoked without authentication, regardless of any authentication traits applied to the operation.

auth trait

Defines the priority ordered authentication schemes supported by a service or operation.