Oauth Token Exchange

POST 
/users/v1/oauth/token

Exchange an authorization_code from the /users/v1/oauth/response/{platform} endpoint for an access token and refresh token.

Request

Header Parameters

user-agent User-Agent
x-rh-client-addr X-Rh-Client-Addr

Possible values: <= 32 characters

IP Address hint

application/json

Body

required

grant_type OAuthTokenEchangeGrantType (string)required

Possible values: [authorization_code]

Supported grant types for OAuth Token Exchange process

code Code (string)required

Possible values: non-empty

authorization_code for the OAuth exchange.

accepted_eula Accepted Eula (boolean)

If true, the user has accepted the EULA.

accepted_tos Accepted Tos (boolean)

If true, the user has accepted the TOS.

accepted_privacy_policy Accepted Privacy Policy (boolean)

If true, the user has accepted the Privacy Policy.

Responses

200

Successful Response

application/json

Schema

Schema

access_token Access Token (string)

Access token for the user.

refresh_token Refresh Token (string)

Refresh token for the user.

needs_eula Needs Eula (boolean)

If true, the user must accept the EULA before a token can be generated.

needs_tos Needs Tos (boolean)

If true, the user must accept the TOS before a token can be generated.

needs_privacy_policy Needs Privacy Policy (boolean)

If true, the user must accept the Privacy Policy before a token can be generated.

regenerated_code Regenerated Code (string)

If present, a new code was generated and can be used after the user accepts the required agreements.

error_message Error Message (string)

Error message if an error occurred.

Example (from schema)

{
  "access_token": "string",
  "refresh_token": "string",
  "needs_eula": false,
  "needs_tos": false,
  "needs_privacy_policy": false,
  "regenerated_code": "string",
  "error_message": "string"
}

403

Error Codes:

• authorization_code_not_found: Authorization code not found or expired

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...