Exchange Ops Token With Jwt Token

Exchange current user token with jwt token

Request

URI

POST

https://{api_host}/suite-api/api/auth/token/exchange

COPY

Query Parameters

boolean

includeServiceDetails

Optional

Constraints: default: false

Set to true to fetch the requested service details, such as the address, port, etc.

Request Body

Request body for exchanging a token

TokenExchangeRequest of type(s) application/json

Required

Show optional properties

{
    "serviceKeys": [
        {}
    ]
}

"{\n  \"serviceKeys\" : [ \"ops-li\", \"ops-ni\" ]\n}"

array of string

serviceKeys

Required

Constraints: minItems: 1

Unique service keys.

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

Token exchange response

Returns TokenExchangeResponse of type(s) application/json

"{\n  \"jwtToken\" : \"token\",\n  \"services\" : [ {\n    \"name\" : \"VCF OPS LI\",\n    \"type\" : \"VCF_OPS_LI\",\n    \"key\" : \"ops-li\",\n    \"address\" : \"0.0.0.0\",\n    \"port\" : 8000,\n    \"addressType\" : \"IPV4\",\n    \"certificates\" : [ ],\n    \"version\" : \"9.1.0.0\"\n  }, {\n    \"name\" : \"VCF OPS NI\",\n    \"type\" : \"VCF_OPS_NI\",\n    \"key\" : \"ops-ni\",\n    \"address\" : \"0.0.0.0\",\n    \"port\" : 8000,\n    \"addressType\" : \"IPV4\",\n    \"certificates\" : [ ],\n    \"basePath\" : \"base-path\",\n    \"version\" : \"9.1.0.0\"\n  } ]\n}"

string

jwtToken

Optional

The JWT token received after a successful token exchange.

array of object

services

Optional

Additional information about services.

400

Invalid service key provided

Operation doesn't return any data structure

500

Something went wrong

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"serviceKeys":["string"]}' https://{api_host}/suite-api/api/auth/token/exchange

On This Page

Description

Request

Query Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Auth Operations

GET

Get Current User