Create Token

Create Token

Creates access token and refresh token for user access

Request
URI
POST
https://sfo-vcf01.rainpole.io/v1/tokens
COPY
Request Body

The spec used to sign the token

TokenCreationSpec of type(s) application/json
Required 
{
    "apiKey": "string",
    "password": "string",
    "username": "string"
}
string
apiKey
Optional

API Key

string
password
Optional

User Password

string
username
Optional

Username

Responses
200

OK

Returns TokenPair of type(s) application/json 
{
    "accessToken": "string",
    "refreshToken": {
        "id": "string"
    }
}
string
accessToken
Optional

Bearer token that can be used to make public API calls

RefreshToken
refreshToken
Optional

This contains refresh token id for the user API access.


201

Created

Returns TokenPair of type(s) application/json 
{
    "accessToken": "string",
    "refreshToken": {
        "id": "string"
    }
}
string
accessToken
Optional

Bearer token that can be used to make public API calls

RefreshToken
refreshToken
Optional

This contains refresh token id for the user API access.


400

Bad Request

Returns Error of type(s) application/json 
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

The error context (e.g. the component where it occurred).

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
remediationMessage
Optional

The localized remediation error message


500

Internal Server Error

Returns Error of type(s) application/json 
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

The error context (e.g. the component where it occurred).

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
remediationMessage
Optional

The localized remediation error message


On This Page
Tokens Operations
POST
Create Token
DELETE
Invalidate Refresh Token
PATCH
Refresh Access Token