/idp - idp-oauth

Rest API Documentation

REST API Documentation for Group idp-oauth, application /idp Version: 4.2.1.3

Endpoints (DRAFT)

GET /oauth2/revoke

Revoke Auth token information

Query Params:

  • token [{'type': 'array', 'items': {'type': 'string'}}]:
  • id_token_hint [{'type': 'string'}]:
  • state [{'type': 'string'}]:
  • post_logout_redirect_uri [{'type': 'string'}]:
  • token_type_hint [{'type': 'string'}]:

Responses:

  • Status Code: 200 Success.

    Content-type: application/json,

    Schema: /components/schemas/Response

  • Status Code: 500 Failure.

    Content-type: application/json,

    Schema: /components/schemas/Response

POST /oauth2/revoke

Revoke Auth token information

Query Params:

  • token [{'type': 'array', 'items': {'type': 'string'}}]:
  • id_token_hint [{'type': 'string'}]:
  • state [{'type': 'string'}]:
  • post_logout_redirect_uri [{'type': 'string'}]:
  • token_type_hint [{'type': 'string'}]:

Responses:

  • Status Code: 200 Success.

    Content-type: application/json,

    Schema: /components/schemas/Response

  • Status Code: 500 Failure.

    Content-type: application/json,

    Schema: /components/schemas/Response

POST /oauth2/token

Get Auth token

Query Params:

  • client_id [{'type': 'string'}]:
  • client_secret [{'type': 'string'}]:
  • client_assertion [{'type': 'string'}]:
  • client_assertion_type [{'type': 'string'}]:
  • grant_type [{'type': 'string'}]:
  • redirect_uri [{'type': 'string'}]:
  • code [{'type': 'string'}]:
  • refresh_token [{'type': 'string'}]:
  • code_verifier [{'type': 'string'}]:
  • username [{'type': 'string'}]:
  • password [{'type': 'string'}]:
  • device_code [{'type': 'string'}]:

Responses:

  • Status Code: 200 Success.

    Content-type: application/json,

    Schema: /components/schemas/OAuthTokenResponse

  • Status Code: 500 Failure.

    Content-type: application/json,

    Schema: /components/schemas/OAuthTokenResponse

GET /oauth2/token/info

Get Auth token information

Query Params:

  • token [{'type': 'string'}]:

Responses:

  • Status Code: 200 Success.

    Content-type: application/json,

    Schema: /components/schemas/OAuthTokenInfoResponse

  • Status Code: 500 Failure.

    Content-type: application/json,

    Schema: /components/schemas/OAuthTokenInfoResponse

POST /oauth2/token/refresh

Refresh Auth token information

Query Params:

  • refresh_token [{'type': 'string'}]: The refresh token, obtained due to token request which is used to get new Access Token.

Responses:

  • Status Code: 200 Success.

    Content-type: application/json,

    Schema: /components/schemas/OAuthTokenResponse

  • Status Code: 500 Failure.

    Content-type: application/json,

    Schema: /components/schemas/OAuthTokenResponse

GET /oauth2/token/validate

Validate Auth token information

Query Params:

  • token [{'type': 'string'}]:
  • patternId [{'type': 'string'}]:

Responses:

  • Status Code: 200 Success.

    Content-type: application/json,

    Schema: /components/schemas/OAuthTokenValidateResponse

  • Status Code: 500 Failure.

    Content-type: application/json,

    Schema: /components/schemas/OAuthTokenValidateResponse## Definitions