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

Field		Type	Description
Name		String	The format is UserX (X=1~12).
Id		String	“1” ~ ”12”
Password		String	The password of the account. Display null on a GET.
RoleId		String	The value of this property is the ID of the Role resource that configured for this account.
Enabled		Boolean	Indicates 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.
PasswordExpiration		String	This property indicates the date and time when this account password expires. If the value is null, the account password never expires.
UserName		String	The value of this property is the user name for this account.
Locked		Boolean	This 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. The account service will unlock it once the lockout duration period has passed.
Description		String	This resource is used to represent an account for the manager for a Redfish implementation.
Links		Object	Expand
	Role	Link	Link to the Role instance which this account is mapped to.
AccountTypes		Array	This property contains an array of the various manager services that the account is allowed to access. Items: string Item count: 1
	AccountTypes[N]	String	“Redfish”, “SNMP”, “ManagerConsole”, “IPMI”, “WebUI”
AccountTypes@Redfish. AllowableValues		Array	Items: string Item count: 5
	AccountTypes@Redfish. AllowableValues[N]	String	[“Redfish”, “SNMP”, “ManagerConsole”, “IPMI”, “WebUI”]
SNMP		Object	Expand. This property contains the SNMP settings for this account when AccountTypes contains “SNMP”.
	AuthenticationProtocol	String	This value indicates authentication conforms to the authentication protocol.
	EncryptionKey	String	The secret authentication key for SNMPv3. Display null on a GET.
	EncryptionKeySet	Boolean	The value of this property is true if a valid value was provided for the AuthenticationKey property. Otherwise, the value is false.
	EncryptionProtocol	String	This value indicates encryption conforms to the encryption protocol.
HostBootstrapAccount		Boolean	Indicates whether this account is a bootstrap account for the host interface. Always set to false.

Status code

HTTP Status Code	Error Message ID
500	InternalError

Example

The following example JSON response is returned:



{
    "RoleId": "Administrator",
    "Links": {
        "Role": {
            "@odata.id": "/redfish/v1/AccountService/Roles/Administrator"
        }
    },
    "@odata.context": "/redfish/v1/$metadata#ManagerAccount.ManagerAccount",
    "UserName": "USERID",
    "Id": "1",
    "Name": "User1",
    "@odata.type": "#ManagerAccount.v1_8_1.ManagerAccount",
    "Password": null,
    "@odata.etag": "\"0000000000000000000000000000000032a05d16\"",
    "Oem": {
        …
    },
    "PasswordExpiration": null,
    "HostBootstrapAccount": false,
    "SNMP": {
        "EncryptionProtocol": "CFB128_AES128",
        "AuthenticationProtocol": "HMAC_SHA96",
        "EncryptionKeySet": false,
        "EncryptionKey": null
    },
    "@odata.id": "/redfish/v1/AccountService/Accounts/1",
    "Locked": false,
    "AccountTypes@Redfish.AllowableValues": [
        "WebUI",
        "Redfish",
        "ManagerConsole",
        "IPMI",
        "SNMP"
    ],
    "Enabled": true,
    "Description": "This resource is used to represent an account for the manager for a Redfish implementation.",
    "PasswordChangeRequired": false,
    "AccountTypes": [
        "WebUI",
        "Redfish",
        "ManagerConsole"
    ]
}

Give documentation feedback

GET – Account properties

Request URL​

Request body​

Response body​

Status code​

Example​

Request URL

Request body

Response body

Status code

Example