Authentication

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
More information: https://helloreverb.com
Contact Info: [email protected]
Version: v1
BasePath:/
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

Models

Table of Contents

Oauth2

Oauth2

Up
post /oauth2/revoke
Revoke an access or refresh token (oauth2Revoke)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • text/json
  • application/xml
  • text/xml
  • application/x-www-form-urlencoded

Request body

body RevocationRequestBody (required)
Body Parameter — Request data

Form parameters

client_id (required)
Form Parameter —
token (required)
Form Parameter —

Responses

200

Token Revoked

400

Bad Request

401

Unauthorized

500

Internal Server Error
Up
post /oauth2/token
Authenticate an API user or issue a new access token (oauth2Token)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • text/json
  • application/xml
  • text/xml
  • application/x-www-form-urlencoded

Request body

body TokenRequestBody (required)
Body Parameter — Request data

Form parameters

grant_type (required)
Form Parameter —
client_id (required)
Form Parameter —
username (required)
Form Parameter —
password (required)
Form Parameter —
scope (required)
Form Parameter —
refresh_token (required)
Form Parameter —

Return type

PasswordTokenResponse

Example data

Content-Type: application/json
{
  "access_token" : "access_token",
  "refresh_token" : "refresh_token",
  "expires_in" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
  • text/json
  • application/xml
  • text/xml

Responses

200

Access Token PasswordTokenResponse

400

Bad Request

401

Unauthorized

500

Internal Server Error

Models

Methods

Table of Contents

  1. PasswordTokenResponse
  2. RevocationRequestBody
  3. TokenRequestBody

PasswordTokenResponseUp

Response returned by the OAUTH2 Token method when grant_type = password
access_token (optional)
String The access token
expires_in (optional)
Integer Access token expiration time in seconds format: int32
refresh_token (optional)
String The refresh token

RevocationRequestBodyUp

The CAM REST API OAUTH2 token revocation request body
client_id (optional)
String Client API key / client ID (always required)
token (optional)
String A refresh or access token value (always required)

TokenRequestBodyUp

The CAM REST API OAUTH2 token request body
grant_type (optional)
String Grant type ("password" or "refresh_token")
client_id (optional)
String Client API key / client ID (always required)
username (optional)
String User's CAM/CSM login name (when grant_type = password)
password (optional)
String User's CAM/CSM password (when grant_type = password)
scope (optional)
String Scope: should be "CAM" (when grant_type = password)
refresh_token (optional)
String A refresh token (when grant_type = refresh_token)