appIdOperation

post

/ccadmin/v1/applicationIds/{id}

App Id Operation. Perform an operation on an Application Id. Operations currently supported: genAuthToken.

• Request
• Response
• Examples

Request

Supported Media Types

• application/json

Path Parameters

id

Type: string

Required: true

The Application ID on which to perform the operation.

Body Parameter

Root Schema : appIdOperation_request

Example

{
    "op":"genAuthToken",
    "type":"application"
}

Properties

op

Type: string

Required: true

Operation type. Valid values: genAuthToken - generate a new auth token for the given application id.

type

Type: string

Required: true

One of either application or extension. Only application is supported at this time.

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : appIdOperation_response

Properties

token

Type: string

If operation is genAuthToken, then this property contains the new token value.

Example application/json

{
    "token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MDk4NTY1OTEsInN1YiI6ImFkbWluIiwiaXNzIjoiYWRtaW4iLCJpYXQiOjE0MDk3NzAxOTF9.T0kaE8Ib35R2XZzp0xk4FRP/266KD1cieZFpPijtniw="
}

Default Response

The error response

Body

Root Schema : errorModel

Type: object

Properties

devMessage

Type: string

An optional non-localized message containing technical information for developers

errorCode

Type: string

The numerical code identifying the error

errors

Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered

message

Type: string

The localized message describing the error

moreInfo

Type: string

An optional non-localized message with more information

o:errorPath

Type: string

An optional machine readable description of where the error occurred

status

Type: string

The HTTP status code

type

Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

• Type: object items
  Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage

Type: string

An optional non-localized message containing technical information for developers

errorCode

Type: string

The numerical code identifying the error

message

Type: string

The localized message describing the error

moreInfo

Type: string

An optional non-localized message with more information

o:errorPath

Type: string

An optional machine readable description of where the error occurred

status

Type: string

The HTTP status code

Examples

Sample Request:

{
  "op": "genAuthToken",
  "type": "application"
}

Sample Response Payload returned by endpoint:

{"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MDk4NTY1OTEsInN1YiI6ImFkbWluIiwiaXNzIjoiYWRtaW4iLCJpYXQiOjE0MDk3NzAxOTF9.T0kaE8Ib35R2XZzp0xk4FRP/266KD1cieZFpPijtniw="}