Skip to main content

GET – Account properties

Use the GET method to retrieve properties in Account resource for Redfish service.

Request URL​

GET https://<BMC_IPADDR>/redfish/v1/AccountService/Accounts/{1...12}

Request body​

None

Response body​

FieldTypeDescription

Name

StringThe format is UserX (X=1~12).

Id

String“1” ~ ”12”

Password

StringThe password of the account. Display null on a GET

RoleId

StringThe value of this property is the ID of the Role resource that configured for this account

Enabled

BooleanIndicates if this account is enabled.

PasswordChangeRequired

Boolean

The value of this property is true if the password for this account must be changed before further access is allowed.

Note
This property is not available in Intel Purley-based systems.

PasswordExpiration

String

This property indicates the date and time when this account password expires. If the value is null, the account password never expires.

Note
This property is not available in Intel Purley-based systems.

UserName

StringThe value of this property is the user name for this account.

Locked

BooleanThis property indicates that the account has been auto-locked by the account service because the lockout threshold has been exceeded. When set to true, the account is locked. A user admin can write the property false to manually unlock, or the account service will unlock it once the lockout duration period has passed.

Description

StringThis resource is used to represent an account for the manager for a Redfish implementation.

Links

ObjectExpand
 

Role

LinkLink to the Role instance which this account is mapped to.

AccountTypes

Array

Items: string

Item count: 1

 

AccountTypes[N]

String“Redfish”

SNMP

ObjectExpand
 

AuthenticationProtocol

StringThis value indicates authentication conforms to the authentication protocol.
 

EncryptionKey

StringThe secret authentication key for SNMPv3. Display null on a GET.
 

EncryptionKeySet

BooleanThe value of this property is true if a valid value was provided for the AuthenticationKey property. Otherwise, the value is false.
 

EncryptionProtocol

StringThis value indicates encryption conforms to the encryption protocol.

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example JSON response is returned:


{
    "UserName": "USERID",
    "@odata.id": "/redfish/v1/AccountService/Accounts/1",
    "SNMP": {
        "AuthenticationProtocol": "None",
        "EncryptionKey": null,
        "EncryptionKeySet": false,
        "EncryptionProtocol": "None"
    },
    "Id": "1",
    "Enabled": true,
    "Links": {
        "Role": {
            "@odata.id": "/redfish/v1/AccountService/Roles/Administrator"
        }
    },
    "AccountTypes": [
        "Redfish"
    ],
    "Name": "User1",
    "@odata.type": "#ManagerAccount.v1_6_0.ManagerAccount",
    "Oem": {
        "Lenovo": {
            "@odata.type": "#LenovoManagerAccount.v1_0_0.LenovoManagerAccount",
            "SSHPublicKey": [
                "",
                "",
                "",
                ""
            ]
        }
    },
    "RoleId": "Administrator",
    "Password": null,
    "PasswordChangeRequired": false,
    "@odata.etag": "\"5b51d6d4824024ed59b\"",
    "Locked": false,
    "Description": "This resource is used to represent an account for the manager for a Redfish implementation."
}