Versions Compared

Version Old Version 1 New Version Current
Changes made by

Jason Andrew

Jason Andrew

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space SBUD and version 5

Status
colourGreen
title?.?.?

The OAuth2 Token REST API can be used to generate a JWT for authenticating calls to other ServiceBroker APIs, as an alternative to authentication via a System Access Tokens.

See the REST Integration Authentication page for more details on the two different means of authenticating ServiceBroker API calls. 

Note

In order to use the OAuth2 Token API, the ServiceBroker Tenant needs to be specifically configured for JWT authentication. 

Please see the REST Integration Authentication page for more details.

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

On this page:

Table of Contents
maxLevel2

Related pages:

Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

Obtain a JWT for authenticating other API calls

POST /up/v5/oauth2/accessToken

HTTP Headers

This API uses the standard ServiceBroker Content-Type HTTP Header, but does not use the standard Authorization header.

API Specifics

Panel
borderColor#D3D3D3

Obtain a JWT for authenticating other API calls

This REST API will return a JWT for use in authenticating other ServiceBroker API calls.

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

POST /up/v5/oauth2/accessToken

HTTP Request Body

This request requires an OAuth2 Token Request object supplied in the HTTP request body.

HTTP Response

Success

On success, an HTTP response code of 200 will be returned, and the response body will be a JSON object of the following format:

Code Block
languagejs
{
  "access_token": "...",
  "token_type": "bearer",
  "expires_in": 60
}

Error

Include Page
_Default Response
_Default Response