AuthenticateOidcActionConfig

import type { AuthenticateOidcActionConfig } from "https://aws-api.deno.dev/v0.4/services/elbv2.ts?docs=full";

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

interface AuthenticateOidcActionConfig {

AuthenticationRequestExtraParams?: {

[key: string]: string | null | undefined;

} | null;

AuthorizationEndpoint: string;

ClientId: string;

ClientSecret?: string | null;

Issuer: string;

OnUnauthenticatedRequest?: AuthenticateOidcActionConditionalBehaviorEnum | null;

Scope?: string | null;

SessionCookieName?: string | null;

SessionTimeout?: number | null;

TokenEndpoint: string;

UseExistingClientSecret?: boolean | null;

UserInfoEndpoint: string;

}

§Properties

AuthenticationRequestExtraParams?: {

[key: string]: string | null | undefined;

} | null

[src]

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

AuthorizationEndpoint: string

[src]

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

ClientId: string

[src]

The OAuth 2.0 client identifier.

ClientSecret?: string | null

[src]

The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.

Issuer: string

[src]

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

OnUnauthenticatedRequest?: AuthenticateOidcActionConditionalBehaviorEnum | null

[src]

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?: string | null

[src]

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

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

SessionCookieName?: string | null

[src]

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

SessionTimeout?: number | null

[src]

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

TokenEndpoint: string

[src]

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

UseExistingClientSecret?: boolean | null

[src]

Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.

UserInfoEndpoint: string

[src]

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