Skip to main content

GET / POST – Collection for accounts

Use the GET / POST method to retrieve properties in account collection for Redfish service.

Request URL​

https://<SMM_IPADDR>/redfish/v1/AccountService/Accounts

Request body​

None

Response body​

Field

Type

Description

Description

String

“BMC User Accounts”

Members

Array

Items: link

Item count: 1~15

 

Members[N]

link

Links to user account resource instances.

  

@odata.id

String

“/redfish/v1/AccountService/Accounts/{id}”

Name

String

Accounts Collection

REST operation — POST​

OperationPropertiesComment
POST

UserName

Length should be between 1~16. Allowed characters: TBD
  • “ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789._-“

Password

If empty password is not allowed, password length should be between the value of PasswordLength in AccountService and 20. Allowed charcters: TBD
  • “ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~!@#$%^&*()-+={}[]|:;\”’<>,?/._0123456789”
Note
If the password is set exceeding 20 characters, the credential will not be able to access IPMI. If the password is set back to equal to or less than 20 characters, the credential will be able to access IPMI again.

RoleId

Must be the RoleId property of an existed Role resource.
Note
RoleId shall not be set to “Administrator+”.

PasswordChangeRequired

Note
  • If there exist Redfish sessions that are POST-created from an account, when the account is deleted, the Redfish sessions, with which user gets a 403 (Forbidden) when accessing the Service, will expire immediately as well; the Redfish sessions, with which user is allowed to access the Service, will still be alive and granted for access until session timeout limit is reached.
  • Using POST to create an account, the input parameter “Enabled” is optional and default value is true.

AccountTypes

[”WebUI”, “Redfish”, “IPMI”]. “WebUI” and “Redfish” should be existed at the same time in this field. If not set, the default account types are [“WebUI”, “Redfish”, “IPMI”]

To create an account, UserName, Password and RoleId must be specified in the request body. PrivacyProtocolPassword is mandatory if a certain EncryptionProtocol is specified(not “None”) when creating a SNMP account.

If REST encounters an error or cannot complete the request, it will return “500 Internal Server Error”, but changes made to the valid properties will not be rolled back.

Note

  • Based on the DMTF Redfish Spec. DSP0266, user may provide the Etag value when user patches a user resource. In other word, the Service allows user not to provide Etag in the header of a PATCH request, but if user provides, the Service will validate Etage value before updating.

Status code​

HTTP Status CodeError Message ID
500InternalError