AWSElasticLoadBalancingAuthenticateOidcActionConfig

Objective-C

@interface AWSElasticLoadBalancingAuthenticateOidcActionConfig

Swift

class AWSElasticLoadBalancingAuthenticateOidcActionConfig

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

Required parameters: [Issuer, AuthorizationEndpoint, TokenEndpoint, UserInfoEndpoint, ClientId]

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable authenticationRequestExtraParams;

    Swift

    var authenticationRequestExtraParams: [String : String]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable authorizationEndpoint;

    Swift

    var authorizationEndpoint: String? { get set }

  • The OAuth 2.0 client identifier.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable clientId;

    Swift

    var clientId: String? { get set }

  • 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

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable clientSecret;

    Swift

    var clientSecret: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable issuer;

    Swift

    var issuer: String? { get set }

  • 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

    Objective-C

    @property (nonatomic) AWSElasticLoadBalancingAuthenticateOidcActionConditionalBehaviorEnum onUnauthenticatedRequest;

    Swift

    var onUnauthenticatedRequest: AWSElasticLoadBalancingAuthenticateOidcActionConditionalBehaviorEnum { get set }

  • 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

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable scope;

    Swift

    var scope: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable sessionCookieName;

    Swift

    var sessionCookieName: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable sessionTimeout;

    Swift

    var sessionTimeout: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable tokenEndpoint;

    Swift

    var tokenEndpoint: String? { get set }

  • 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

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable useExistingClientSecret;

    Swift

    var useExistingClientSecret: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable userInfoEndpoint;

    Swift

    var userInfoEndpoint: String? { get set }