AuthenticateOidcActionConfig

public struct AuthenticateOidcActionConfig : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let authenticationRequestExtraParams: [String : String]?

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

    Declaration

    Swift

    public let authorizationEndpoint: String

  • The OAuth 2.0 client identifier.

    Declaration

    Swift

    public let clientId: String

  • 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.

    Declaration

    Swift

    public let clientSecret: String?

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

    Declaration

    Swift

    public let issuer: String

  • 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.

    Declaration

    Swift

    public let onUnauthenticatedRequest: AuthenticateOidcActionConditionalBehaviorEnum?

  • 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.

    Declaration

    Swift

    public let scope: String?

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

    Declaration

    Swift

    public let sessionCookieName: String?

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

    Declaration

    Swift

    public let sessionTimeout: Int64?

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

    Declaration

    Swift

    public let tokenEndpoint: String

  • 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.

    Declaration

    Swift

    public let useExistingClientSecret: Bool?

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

    Declaration

    Swift

    public let userInfoEndpoint: String

  • Undocumented

    Declaration

    Swift

    public init(authenticationRequestExtraParams: [String : String]? = nil, authorizationEndpoint: String, clientId: String, clientSecret: String? = nil, issuer: String, onUnauthenticatedRequest: AuthenticateOidcActionConditionalBehaviorEnum? = nil, scope: String? = nil, sessionCookieName: String? = nil, sessionTimeout: Int64? = nil, tokenEndpoint: String, useExistingClientSecret: Bool? = nil, userInfoEndpoint: String)