The Amazon Chime SDK Identity, Media Pipelines, Meetings, and Messaging APIs are now published on the new Amazon Chime SDK API Reference. For more information, see the Amazon Chime SDK API Reference.
User
The user on the Amazon Chime account.
Contents
- UserId
-
The user ID.
Type: String
Required: Yes
- AccountId
-
The Amazon Chime account ID.
Type: String
Required: No
- AlexaForBusinessMetadata
-
The Alexa for Business metadata.
Type: AlexaForBusinessMetadata object
Required: No
- DisplayName
-
The display name of the user.
Type: String
Required: No
- InvitedOn
-
Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
Type: Timestamp
Required: No
- LicenseType
-
The license type for the user.
Type: String
Valid Values:
Basic | Plus | Pro | ProTrialRequired: No
- PersonalPIN
-
The user's personal meeting PIN.
Type: String
Required: No
- PrimaryEmail
-
The primary email address of the user.
Type: String
Pattern:
.+@.+\..+Required: No
- PrimaryProvisionedNumber
-
The primary phone number associated with the user.
Type: String
Required: No
- RegisteredOn
-
Date and time when the user is registered, in ISO 8601 format.
Type: Timestamp
Required: No
- UserInvitationStatus
-
The user invite status.
Type: String
Valid Values:
Pending | Accepted | FailedRequired: No
- UserRegistrationStatus
-
The user registration status.
Type: String
Valid Values:
Unregistered | Registered | SuspendedRequired: No
- UserType
-
The user type.
Type: String
Valid Values:
PrivateUser | SharedDeviceRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
