Cosmic User API Reference

listVpnUsers

Lists vpn users

Request parameters

Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
domainidlist only resources belonging to the domain specifiedfalse
idThe uuid of the Vpn userfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf 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 falsefalse
pagefalse
pagesizefalse
projectidlist objects by projectfalse
usernamethe username of the vpn user.false

Response Tags

Response NameDescription
idthe vpn userID
accountthe account of the remote access vpn
domainthe domain name of the account of the remote access vpn
domainidthe domain id of the account of the remote access vpn
projectthe project name of the vpn
projectidthe project id of the vpn
statethe state of the Vpn User
usernamethe username of the vpn user