Skip to main content
ZStack
Operations Management/Tenant Management (Plus)/SSO Operations

GetOAuth2Token

GetOAuth2Token

GET/zstack/v1/get/oauth2/token

Operation ID

GetOAuth2Token

Since

4.6.21

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • systemTags
    List

    Optional. The system tags.

  • userTags
    List

    Optional. The user tags.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • success
    booleanRequired

    Whether the operation succeeded.

  • inventory
    OAuth2TokenInventoryRequired

    See inventory.

    • accessToken
      StringRequired

      The access token.

    • idToken
      StringRequired

      The id token.

    • refreshToken
      StringRequired

      The refresh token.

    • uuid
      StringRequired

      The resource UUID.

    • clientUuid
      StringRequired

      The client UUID.

    • userUuid
      StringRequired

      The user UUID.

    • createDate
      TimestampRequired

      The creation date.

    • lastOpDate
      TimestampRequired

      The last operation date.

  • error
    ErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • code
      StringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • description
      StringRequired

      The brief description of the error.

    • details
      StringRequired

      The details about the error.

    • elaboration
      StringRequired

      The reserved field. Default value: null.

    • opaque
      LinkedHashMapRequired

      The reserved field. Default value: null.

    • cause
      ErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.