API operations related to authentication operations, see the Authentication Process section for a detailed description of the authentication flows available.
Get an OAuth2 token
Request
Responses
200
Response success
400
Malformed request.
401
Unauthorized access, invalid credentials were used.
403
Access forbidden. Current token does not have the necessary authority for the operation.
422
Invalid data was sent.
post/auth/token
Request samples
- Payload
- curl
- JavaScript
application/json
{- "grant_type": "client_credentials",
- "auth_id": "admin",
- "auth_secret": "password"
}Response samples
- 200
- 400
- 401
- 403
- 422
application/json
{- "access_token": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
- "token_type": "bearer",
- "expires_in": 3600,
- "scope": "observer",
- "User": {
- "auth_id": "jsmith",
- "AccessLevel": "observer"
}
}Obtain a new API Key
SecurityOAuth2 or ApiKey
Responses
200
Response success
401
Unauthorized access, invalid credentials were used.
403
Access forbidden. Current token does not have the necessary authority for the operation.
post/auth/registerApiKey
Request samples
- curl
- JavaScript
Response samples
- 200
- 401
- 403
application/json
{- "ApiKey": "string"
}Revoke an API key
SecurityOAuth2 or ApiKey
Responses
200
Response success
400
Malformed request.
401
Unauthorized access, invalid credentials were used.
403
Access forbidden. Current token does not have the necessary authority for the operation.
422
Invalid data was sent.
post/auth/revokeApiKey
Request samples
- Payload
- curl
- JavaScript
application/json
{- "ApiKey": "string"
}Response samples
- 200
- 400
- 401
- 403
- 422
application/json
{- "status": 200,
- "success": true
}