This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Support.
Information about an authentication profile. An authentication profile is a resource that stores the authentication settings for users in your contact center. You use authentication profiles to set up IP address range restrictions and session timeouts. For more information, see Set IP address restrictions or session timeouts.
Contents
- AllowedIps
-
A list of IP address range strings that are allowed to access the Amazon Connect instance. For more information about how to configure IP addresses, see Configure IP address based access control in the Amazon Connect Administrator Guide.
Type: Array of strings
Length Constraints: Minimum length of 2. Maximum length of 50.
Pattern:
^[A-Za-z0-9:/]*$Required: No
- Arn
-
The Amazon Resource Name (ARN) for the authentication profile.
Type: String
Required: No
- BlockedIps
-
A list of IP address range strings that are blocked from accessing the Amazon Connect instance. For more information about how to configure IP addresses, see Configure IP address based access control in the Amazon Connect Administrator Guide.
Type: Array of strings
Length Constraints: Minimum length of 2. Maximum length of 50.
Pattern:
^[A-Za-z0-9:/]*$Required: No
- CreatedTime
-
The timestamp when the authentication profile was created.
Type: Timestamp
Required: No
- Description
-
The description for the authentication profile.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 250.
Required: No
- Id
-
A unique identifier for the authentication profile.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
- IsDefault
-
Shows whether the authentication profile is the default authentication profile for the Amazon Connect instance. The default authentication profile applies to all agents in an Amazon Connect instance, unless overridden by another authentication profile.
Type: Boolean
Required: No
- LastModifiedRegion
-
The AWS Region where the authentication profile was last modified.
Type: String
Pattern:
[a-z]{2}(-[a-z]+){1,2}(-[0-9])?Required: No
- LastModifiedTime
-
The timestamp when the authentication profile was last modified.
Type: Timestamp
Required: No
- MaxSessionDuration
-
The long lived session duration for users logged in to Amazon Connect, in minutes. After this time period, users must log in again. For more information, see Configure the session duration in the Amazon Connect Administrator Guide.
Type: Integer
Valid Range: Minimum value of 360. Maximum value of 720.
Required: No
- Name
-
The name for the authentication profile.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No
- PeriodicSessionDuration
-
The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, see Configure the session duration in the Amazon Connect Administrator Guide.
Type: Integer
Valid Range: Minimum value of 10. Maximum value of 60.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
