Apache CloudStack 4.23.0.0 Root Admin API Reference

listUserKeys

Lists the API key pairs (API and secret keys) of a user.

Request parameters

Parameter NameDescriptionRequired
apikeyfilterAPI key of the key pair.false
keypairidID of the key pair.false
keywordList by keywordfalse
listallLists all API key pairs of users that are accessible by the calling account. Only available for administrators. Defaults to false.false
pagefalse
pagesizefalse
showpermissionsWhether API Key rules should be returned. Defaults to false.false
useridID of the user that owns the keys.false

Response Tags

Response NameDescription
idID of the API key pair.
accountidAccount ID.
accountnameAccount name.
accounttypeAccount type.
apikeyThe API key of the registered user.
createdAPI key pair creation timestamp.
descriptionAPI key pair description.
domainName of the domain which the account belongs to.
domainidID of the domain which the account belongs to.
domainpathPath of the domain which the account belongs to.
enddateAPI key pair expiration date.
nameName of the API key pair
permissionsPermissions of the API key pair.
roleidID of the role.
rolenameName of the role.
roletypeType of the role (Admin, ResourceAdmin, DomainAdmin, User).
secretkeyThe secret key of the registered user.
startdateAPI key pair start date.
stateState of the API key pair.
useridID of the user that owns the keypair.
usernameUsername of the keypair's owner.