CyberArk, LDAP, RADIUS

This method authenticates a user to Privilege Cloud and returns a token that can be used in subsequent web services calls. In addition, this method enables you to set a new password.

URL

Method

URL

CyberArk

 

 
https://<subdomain>.privilegecloud.cyberark.com/PasswordVault/API/auth/Cyberark/Logon/

LDAP

 

 
https://<subdomain>.privilegecloud.cyberark.com/PasswordVault/API/auth/LDAP/Logon/

RADIUS

 

 
https://<subdomain>.privilegecloud.cyberark.com/PasswordVault/API/auth/RADIUS/Logon/

Resource information

HTTP method

POST

Content type

application/json

Body parameters

  
{
"username":"<user_name>",
"password":"<password>",
"newPassword":"<NewPassword>",
}

 

Parameter

Description

username

(mandatory)

The name of the user who is logging in to Privilege Cloud.

Type: string

password

(mandatory)

The password used by the user to log in to Privilege Cloud.

Type: string

newPassword

(optional)

Set this parameter with a new password to change the user's password.

This parameter can be used with the following authentication methods:

  • CyberArk
  • LDAP

Type: string

concurrentSession (optional)

Set this parameter to True to enable the user to open multiple connection sessions simultaneously.

Up to 300 concurrent sessions are supported.

Valid values: True/False

Default: False

Type: boolean

Result

  
{ 
"<session token>"
}

This method returns the session token.

Return codes

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