The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Paws::ELBv2::AuthenticateOidcActionConfig

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::ELBv2::AuthenticateOidcActionConfig object:

  $service_obj->Method(Att1 => { AuthenticationRequestExtraParams => $value, ..., UserInfoEndpoint => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::ELBv2::AuthenticateOidcActionConfig object:

  $result = $service_obj->Method(...);
  $result->Att1->AuthenticationRequestExtraParams

DESCRIPTION

Request parameters when using an identity provider (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.

ATTRIBUTES

AuthenticationRequestExtraParams => Paws::ELBv2::AuthenticateOidcActionAuthenticationRequestExtraParams

  The query parameters (up to 10) to include in the redirect request to
the authorization endpoint.

REQUIRED AuthorizationEndpoint => Str

  The authorization endpoint of the IdP. This must be a full URL,
including the HTTPS protocol, the domain, and the path.

REQUIRED ClientId => Str

  The OAuth 2.0 client identifier.

REQUIRED ClientSecret => Str

  The OAuth 2.0 client secret.

REQUIRED Issuer => Str

  The OIDC issuer identifier of the IdP. This must be a full URL,
including the HTTPS protocol, the domain, and the path.

OnUnauthenticatedRequest => Str

  The behavior if the user is not authenticated. The following are
possible values:
  • deny - Return an HTTP 401 Unauthorized error.

  • allow - Allow the request to be forwarded to the target.

  • authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.

Scope => Str

  The set of user claims to be requested from the IdP. The default is
C<openid>.

To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.

SessionCookieName => Str

  The name of the cookie used to maintain session information. The
default is AWSELBAuthSessionCookie.

SessionTimeout => Int

  The maximum duration of the authentication session, in seconds. The
default is 604800 seconds (7 days).

REQUIRED TokenEndpoint => Str

  The token endpoint of the IdP. This must be a full URL, including the
HTTPS protocol, the domain, and the path.

REQUIRED UserInfoEndpoint => Str

  The user info endpoint of the IdP. This must be a full URL, including
the HTTPS protocol, the domain, and the path.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::ELBv2

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues