Get user types

This method returns information about user types.

To run this Web service, you must have the following permissions:

Audit Users

URL

https://<IIS_Server_Ip>/PasswordVault/API/UserTypes/

Make sure there are no spaces in the URL.

The following characters are not supported in URL values: + & %
If the URL includes a dot (.), add a forward slash (/) at the end of the URL. For example: api/Safes/MySafe/Members/user@cyber.com/

Resource information

HTTP method	Content type
GET	application/json

Header parameter

Parameter	Description
Authorization	The token that identifies the session. Type: String Valid values: A session token that was returned from the “Logon” method.

Parameter

Description

Authorization

The token that identifies the session.

Type: String

Valid values: A session token that was returned from the “Logon” method.

Body parameters

None.

Result

{"UserTypes":[{"UserTypeId":31,"UserTypeName":"CPM","AllowedClientInterfaces":["CPM"]},
{"UserTypeId":32,"UserTypeName":"PVWA","AllowedClientInterfaces":["PVWAApp"]},
{"UserTypeId":33,"UserTypeName":"AppProvider","AllowedClientInterfaces":["AppPrv"]},
{"UserTypeId":34,"UserTypeName":"EPVUser","AllowedClientInterfaces":["EVD","GUI","HTTPGW","IBVSDK","NAPI","PACLI","PIMSu","PSM","PSMP","PVWA","WINCLIENT","XAPI"]},
{"UserTypeId":35,"UserTypeName":"AIMAccount","AllowedClientInterfaces":["AIMApp","PAPI"]},
{"UserTypeId":75,"UserTypeName":"PSMHTML5Gateway","AllowedClientInterfaces":["PSMGWApp"]},
{"UserTypeId":36,"UserTypeName":"PSM","AllowedClientInterfaces":["PSMApp"]},
{"UserTypeId":37,"UserTypeName":"OPMProvider","AllowedClientInterfaces":["AppPrv"]},
{"UserTypeId":38,"UserTypeName":"PIMProvider","AllowedClientInterfaces":["APIGW","AppPrv"]},
{"UserTypeId":39,"UserTypeName":"OPMUser","AllowedClientInterfaces":["PIMSu"]},
{"UserTypeId":43,"UserTypeName":"PSMUser","AllowedClientInterfaces":["PSM","PSMApp","PSMP","PVWA"]},
{"UserTypeId":44,"UserTypeName":"iSeriesApp","AllowedClientInterfaces":["AIMApp"]},
{"UserTypeId":51,"UserTypeName":"CIFS","AllowedClientInterfaces":["CIFS","CIFSApp"]},
{"UserTypeId":52,"UserTypeName":"FTP","AllowedClientInterfaces":["FTP","FTPApp"]},
{"UserTypeId":53,"UserTypeName":"FEWA","AllowedClientInterfaces":["FEWA"]},
{"UserTypeId":54,"UserTypeName":"SFE","AllowedClientInterfaces":["SFEAPP"]},
{"UserTypeId":55,"UserTypeName":"AutoIBVUser","AllowedClientInterfaces":["DCA","EVD","FTP","HTTPGW","IBVSDK","NAPI","PACLI","XAPI"]},
{"UserTypeId":56,"UserTypeName":"IBVUser","AllowedClientInterfaces":["CIFS","DC","EMAIL","FEWA","GUI","IBVSDK","SEGEMail","SFEWebUI","WINCLIENT"]},
{"UserTypeId":57,"UserTypeName":"CommunityIBVUser","AllowedClientInterfaces":["DC","FTP","IBVSDK","SFEWebUI"]},
{"UserTypeId":58,"UserTypeName":"DCAUser","AllowedClientInterfaces":["DCA"]},
{"UserTypeId":59,"UserTypeName":"SDVSDK","AllowedClientInterfaces":["EVD","HTTPGW","IBVSDK","NAPI","PACLI","XAPI"]},
{"UserTypeId":60,"UserTypeName":"DCAInstance","AllowedClientInterfaces":["DCAAPP"]},
{"UserTypeId":63,"UserTypeName":"FeDCAInstance","AllowedClientInterfaces":["DCAAPP"]},
{"UserTypeId":64,"UserTypeName":"EpDCAInstance","AllowedClientInterfaces":["DCAAPP"]},
{"UserTypeId":65,"UserTypeName":"SecureEpClientUser","AllowedClientInterfaces":["CIFS","DC","DCA","EMAIL","FEWA","FTP","GUI","HTTPGW","IBVSDK","NAPI","PACLI","SEGEMail","SFEWebUI","WINCLIENT","XAPI"]},
{"UserTypeId":66,"UserTypeName":"ClientlessUser","AllowedClientInterfaces":["CIFS","FEWA","FTP","HTTPGW","IBVSDK","SFEWebUI"]},
{"UserTypeId":67,"UserTypeName":"AdHocRecipient","AllowedClientInterfaces":["SFEWebUI"]},
{"UserTypeId":68,"UserTypeName":"SecureEmailUser","AllowedClientInterfaces":["EMAIL","IBVSDK","SEGEMail","SFEWebUI"]},
{"UserTypeId":69,"UserTypeName":"SEG","AllowedClientInterfaces":["SEGApp"]},
{"UserTypeId":72,"UserTypeName":"PSMPADBridge","AllowedClientInterfaces":["PSMPApp"]},
{"UserTypeId":70,"UserTypeName":"PSMPServer","AllowedClientInterfaces":["PSMPApp"]},
{"UserTypeId":71,"UserTypeName":"SDVUser","AllowedClientInterfaces":["CIFS","EMAIL","EVD","FEWA","GUI","HTTPGW","IBVSDK","NAPI","PACLI","SEGEMail","SFEWebUI","WINCLIENT","XAPI"]},
{"UserTypeId":73,"UserTypeName":"zOSAIMUser","AllowedClientInterfaces":["AppPrv"]},
{"UserTypeId":80,"UserTypeName":"Synchronizer","AllowedClientInterfaces":["AppPrv","PVWA","Synchrnzr"]},
{"UserTypeId":81,"UserTypeName":"CCP","AllowedClientInterfaces":["AppPrv","CCP","PVWA"]},
{"UserTypeId":82,"UserTypeName":"DAP","AllowedClientInterfaces":["AppPrv","DAP","PVWA"]},
{"UserTypeId":86,"UserTypeName":"EPVUserLite","AllowedClientInterfaces":["EVD","PACLI","PIMSu","PSM","PSMP","PVWA","WINCLIENT"]},
{"UserTypeId":87,"UserTypeName":"BasicUser","AllowedClientInterfaces":["PVWA"]},
{"UserTypeId":99,"UserTypeName":"CCPEndpoints","AllowedClientInterfaces":[""]},
{"UserTypeId":501,"UserTypeName":"IBVSDK","AllowedClientInterfaces":["IBVSDK"]},
{"UserTypeId":503,"UserTypeName":"IBVSDK","AllowedClientInterfaces":["IBVSDK"]},
{"UserTypeId":504,"UserTypeName":"DRUser","AllowedClientInterfaces":["DR"]},
{"UserTypeId":505,"UserTypeName":"BIZ_USER","AllowedClientInterfaces":["PVWA"]},
{"UserTypeId":506,"UserTypeName":"Biz-User","AllowedClientInterfaces":["PVWA"]},
{"UserTypeId":507,"UserTypeName":"BizUser","AllowedClientInterfaces":["PVWA"]},
{"UserTypeId":508,"UserTypeName":"bizuser","AllowedClientInterfaces":["PVWA"]},
{"UserTypeId":509,"UserTypeName":"BackupUser","AllowedClientInterfaces":["CABACKUP"]},
{"UserTypeId":590,"UserTypeName":"BizUser","AllowedClientInterfaces":["PVWA"]},
{"UserTypeId":591,"UserTypeName":"EXTUser","AllowedClientInterfaces":["PIMSu","PSM","PSMP","PVWA"]},
{"UserTypeId":10,"UserTypeName":"Built-InAdmins","AllowedClientInterfaces":["UNKNOWN","WINCLIENT","CIFS","FTP","PAPI","PACLI","XAPI","CPM","DC","DR","HTTPGW","PVWA","CABACKUP","DCA","NAPI","FEWA","CAUnlock","AppPrv","CACrypt","ENE","SFEWebUI","SFEAPP","GUI","FTPApp","CIFSApp","PVWAApp","DCAAPP","AIMApp","IBVSDK","EVD","EMAIL","PIMSu","PSMApp","SEGEMail","SEGApp","PSMP","PSMPApp","PTAApp","PSM","PSMGWApp","APIGW","Discover","xRayAdmin","PSMWeb","EPMUser","Synchrnzr","CCP","DAP","DAPApp","Telemetry","IDptivApp",""]},
{"UserTypeId":11,"UserTypeName":"ENE","AllowedClientInterfaces":["ENE"]},
{"UserTypeId":74,"UserTypeName":"PTA","AllowedClientInterfaces":["PTAApp","PVWA"]},
{"UserTypeId":84,"UserTypeName":"Telemetry","AllowedClientInterfaces":["PVWA","Telemetry"]},
{"UserTypeId":85,"UserTypeName":"IDaptive","AllowedClientInterfaces":["IDptivApp","PVWA"]},
{"UserTypeId":76,"UserTypeName":"DiscoveryApp","AllowedClientInterfaces":["Discover","PVWA"]},
{"UserTypeId":77,"UserTypeName":"xRayAdminApp","AllowedClientInterfaces":["NAPI","PACLI","PVWA","XAPI","xRayAdmin"]},
{"UserTypeId":78,"UserTypeName":"PSMWeb","AllowedClientInterfaces":["PSMWeb","PVWA"]},
{"UserTypeId":79,"UserTypeName":"EPMUser","AllowedClientInterfaces":["EPMUser","PVWA"]},
{"UserTypeId":83,"UserTypeName":"DAPService","AllowedClientInterfaces":["DAPApp","PVWA"]}]}

Parameter	Description
id	The unique ID of the user. Type: Number
userType	The user type as defined in the license. Type: String
authorizedInterfaces	The CyberArk interfaces that the user is authorized to use. Type: String

Parameter

Description

The unique ID of the user.

Type: Number

userType

The user type as defined in the license.

Type: String

authorizedInterfaces

The CyberArk interfaces that the user is authorized to use.

Type: String

Return codes

For a complete list of return codes, see Return Codes.