API Guide

Authentication
Provides access to APIs.
Topics:
• POST /auth/token
• POST /auth/token/extend
• GET /auth/users
• POST /auth/users
• GET /auth/users/{userId}
• PUT /auth/users/{userId}
• DELETE /auth/users/{userId}
• PUT /auth/users/{userId}/password
• PUT /auth/users/self/password
• PUT /auth/users/{userId}/cli-access
• PUT /auth/users/{userId}/user-role
• PUT /auth/users/{userId}/user-state
• GET /auth/domains
• GET /auth/servers/ldap
• PUT /auth/servers/ldap
• DELETE /auth/servers/ldap
POST /auth/token
Retrieves a new token.
API
POST /auth/token
Description This API returns an authentication token to be used for access.
Parameters
Table 7. API parameters
Filter name Description
body
required (body)
Login request to get the access token.
{
"username": "[e-mail]",
"password": "examplePass",
"authDomain": "LDAP_AUTH"
}
Responses 200 — Success or error response
{
"token": "string",
"refreshToken": "string"
}
400 — Invalid login request
{
"new_object_id": "string",
"id": "string",
"message": "string",
5
18 Authentication