Cosmic Admin API Reference

listUsers

Lists user accounts

Request parameters

Parameter Name	Description	Required
account	list resources by account. Must be used with the domainId parameter.	false
accounttype	List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.	false
domainid	list only resources belonging to the domain specified	false
id	List user by ID.	false
isrecursive	defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.	false
keyword	List by keyword	false
listall	If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false	false
page		false
pagesize		false
state	List users by state of the user account.	false
username	List user by the username	false

Response Tags

Response Name	Description
id	the user ID
account	the account name of the user
accountid	the account ID of the user
accounttype	the account type of the user
apikey	the api key of the user
created	the date and time the user account was created
domain	the domain name of the user
domainid	the domain ID of the user
email	the user email address
firstname	the user firstname
iscallerchilddomain	the boolean value representing if the updating target is in caller's child domain
isdefault	true if user is default, false otherwise
lastname	the user lastname
secretkey	the secret key of the user
state	the user state
timezone	the timezone user was created in
username	the user name