ManagerAccount
Description
This resource shall represent a user account for the manager in a Redfish implementation. The account shall indicate the allowed access to one of more services in the manager.
Fields
| Field | Type | Description |
|---|---|---|
AccountExpiration | string | This property shall contain the date and time when this account expires. The service shall disable or delete an account that has expired. This property shall not apply to accounts created by the Redfish Host Interface Specification-defined credential bootstrapping. If the value is `null`, or the property is not present, the account never expires. |
Certificates | CertificateCollection | This property shall contain a link to a resource collection of type `CertificateCollection` that represents the user identity certificates for this account. |
Description | Description | |
EmailAddress | string | This property shall contain the email address associated with this account. |
Enabled | boolean | This property shall indicate whether an account is enabled. If `true`, the account is enabled and the user can log in. If `false`, the account is disabled and, in the future, the user cannot log in. |
HostBootstrapAccount | boolean | This property shall indicate whether this account is a bootstrap account created by the Redfish Host Interface Specification-defined credential bootstrapping. |
Id | Id | |
Keys | KeyCollection | This property shall contain a link to a resource collection of type `KeyCollection` that contains the keys that can be used to authenticate this account. |
Locked | boolean | This property shall indicate whether the account service automatically locked the account because the `AccountLockoutThreshold` was exceeded. To manually unlock the account before the lockout duration period, an administrator shall be able to change the property to `false` to clear the lockout condition. |
Name | Name | |
PasswordChangeRequired | boolean | This property shall indicate whether the service requires that the password for this account be changed before further access to the account is allowed. The implementation may deny access to the service if the password has not been changed. A manager account created with an initial `PasswordChangeRequired` value of `true` may force a password change before first access of the account. When the `Password` property for this account is updated, the service shall set this property to `false`. |
PasswordExpiration | string | This property shall contain the date and time when this account password expires. If the value is `null`, the account password never expires. If provided during account creation or password modification, this value shall override the value of the `PasswordExpirationDays` property in the `AccountService` resource. |
PhoneNumber | string | This property shall contain the contact phone number associated with this account. |
RoleId | string | This property shall contain the `RoleId` of the role resource configured for this account. The service shall reject `POST`, `PATCH`, or `PUT` operations that provide a `RoleId` that does not exist by returning the HTTP `400 Bad Request` status code. |
SecretKeySet | boolean | This property shall indicate if the secret key for RFC6238-defined Time-based One-Time Password (TOTP) multi-factor authentication is set. |
UserName | string | This property shall contain the username for this account. |