GetAccountByName

09/16/2024 Contributors

PDFs

You can use GetAccountByName to get details about a specific account, given its username.

Parameters

This method has the following input parameters:

Name	Description	Type	Default value	Required
username	User name for the account.	string	None	Yes

Name

Description

Type

Default value

Required

username

User name for the account.

string

None

Yes

Return value

This method has the following return value:

Name	Description	Type
account	Account details.	account

Name

Description

Type

account

Account details.

account

Request example

Requests for this method are similar to the following example:

{
   "method": "GetAccountByName",
   "params": {
     "username"  : "jimmyd"
   },
   "id" : 1
}

Response example

This method returns a response similar to the following example:

{
    "account": {
        "attributes": {},
        "username": "jimmyd",
        "targetSecret": "targetsecret",
        "volumes": [],
        "enableChap": true,
        "status": "active",
        "accountID": 1,
        "storageContainerID": "abcdef01-1234-5678-90ab-cdef01234567",
        "initiatorSecret": "initiatorsecret"
    }
}

New since version

9.6