Jump to

• Request
• Response

Request an access token

post

https://iam.sbc.com/console/auth/realms/sbc/protocol/openid-connect/token

This operation authenticates the supplied credentials and returns the access and refresh tokens. The access token can be used as authorization bearer token to make REST API calls. The refresh token can be used to obtain a new access token if the old access token expires.

Request

There are no request parameters for this operation.

Supported Media Types

• application/x-www-form-urlencoded

Request Body - application/x-www-form-urlencoded ()

Root Schema : schema

Match One Schema

Show Source

• object AccessTokenRequest
  Credentials for the token request
• object RefreshTokenRequest
  Credentials for the refresh token request

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/AccessTokenRequest"
        },
        {
            "$ref":"#/components/schemas/RefreshTokenRequest"
        }
    ]
}

Nested Schema : AccessTokenRequest

Type: object

Credentials for the token request

Show Source

• client_id(required): string
  An Identifier of the client which interacts with the IAM to authenticate users and obtain tokens
• grant_type(required): string
  Allowed Values: [ "password" ]
• password(required): string
• username(required): string

{
    "description":"Credentials for the token request",
    "type":"object",
    "required":[
        "client_id",
        "username",
        "password",
        "grant_type"
    ],
    "properties":{
        "client_id":{
            "type":"string",
            "description":"An Identifier of the client which interacts with the IAM to authenticate users and obtain tokens"
        },
        "username":{
            "type":"string"
        },
        "password":{
            "type":"string"
        },
        "grant_type":{
            "type":"string",
            "enum":[
                "password"
            ]
        }
    },
    "example":{
        "client_id":"cnsbc-api-access",
        "username":"foo",
        "password":"bar",
        "grant_type":"password"
    }
}

Example:

{
    "client_id":"cnsbc-api-access",
    "username":"foo",
    "password":"bar",
    "grant_type":"password"
}

Nested Schema : RefreshTokenRequest

Type: object

Credentials for the refresh token request

Show Source

• client_id(required): string
  An Identifier of the client which interacts with the IAM to authenticate users and obtain tokens
• grant_type(required): string
  Allowed Values: [ "refresh_token" ]
• refresh_token(required): string (base64)

{
    "description":"Credentials for the refresh token request",
    "type":"object",
    "required":[
        "client_id",
        "refresh_token",
        "grant_type"
    ],
    "properties":{
        "client_id":{
            "type":"string",
            "description":"An Identifier of the client which interacts with the IAM to authenticate users and obtain tokens"
        },
        "refresh_token":{
            "type":"string",
            "format":"base64"
        },
        "grant_type":{
            "type":"string",
            "enum":[
                "refresh_token"
            ]
        }
    },
    "example":{
        "client_id":"cnsbc-api-access",
        "refresh_token":"eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lk",
        "grant_type":"refresh_token"
    }
}

Example:

{
    "client_id":"cnsbc-api-access",
    "refresh_token":"eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lk",
    "grant_type":"refresh_token"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful Access Token Request

Body ()

Root Schema : TokenResponse

Type: object

Contains information related to the access token response

Show Source

• access_token(required): string (base64)
• expires_in(required): integer
  Time when the access token expires
• not-before-policy: integer
  This ensures that any tokens issued before that time become invalid
• refresh_expires_in(required): integer
  Time when the refresh token expires
• refresh_token(required): string (base64)
• scope: string
  This lists down the resources the client is authorized to access. Specify scopes as space-separated list. For example - scope: profile email, where profile and email are separate resources that can accessed by the client.
• session_state: string (uuid)
  This represents an end-user login state
• token_type(required): string
  Allowed Values: [ "Bearer" ]

{
    "type":"object",
    "description":"Contains information related to the access token response",
    "properties":{
        "access_token":{
            "type":"string",
            "format":"base64"
        },
        "expires_in":{
            "type":"integer",
            "description":"Time when the access token expires"
        },
        "refresh_token":{
            "type":"string",
            "format":"base64"
        },
        "refresh_expires_in":{
            "type":"integer",
            "description":"Time when the refresh token expires"
        },
        "token_type":{
            "type":"string",
            "enum":[
                "Bearer"
            ]
        },
        "not-before-policy":{
            "type":"integer",
            "description":"This ensures that any tokens issued before that time become invalid"
        },
        "session_state":{
            "type":"string",
            "format":"uuid",
            "description":"This represents an end-user login state"
        },
        "scope":{
            "type":"string",
            "description":"This lists down the resources the client is authorized to access. Specify scopes as space-separated list. For example - scope: profile email, where profile and email are separate resources that can accessed by the client."
        }
    },
    "required":[
        "access_token",
        "expires_in",
        "refresh_token",
        "refresh_expires_in",
        "token_type"
    ],
    "example":{
        "access_token":"eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia",
        "expires_in":900,
        "refresh_token":"eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lk",
        "refresh_expires_in":3600,
        "token_type":"Bearer",
        "not-before-policy":0,
        "session_state":"3d5ee6c7-d2e1-48f6-8fff-9164a179175a",
        "scope":"email profile"
    }
}

Example:

{
    "access_token":"eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia",
    "expires_in":900,
    "refresh_token":"eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lk",
    "refresh_expires_in":3600,
    "token_type":"Bearer",
    "not-before-policy":0,
    "session_state":"3d5ee6c7-d2e1-48f6-8fff-9164a179175a",
    "scope":"email profile"
}

400 Response

Error in the Access Token Request

Body ()

Root Schema : AccessTokenErr

Type: object

Error returned in the access token response message

Show Source

• error(required): string
• error_description: string
• error_uri: string

{
    "description":"Error returned in the access token response message",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "type":"string"
        },
        "error_description":{
            "type":"string"
        },
        "error_uri":{
            "type":"string"
        }
    }
}

401 Response

Error in the Access Token Request

Body ()

Root Schema : AccessTokenErr

Type: object

Error returned in the access token response message

Show Source

• error(required): string
• error_description: string
• error_uri: string

{
    "description":"Error returned in the access token response message",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "type":"string"
        },
        "error_description":{
            "type":"string"
        },
        "error_uri":{
            "type":"string"
        }
    }
}

405 Response

Method Not Allowed

Body ()

Root Schema : AccessTokenErr

Type: object

Error returned in the access token response message

Show Source

• error(required): string
• error_description: string
• error_uri: string

{
    "description":"Error returned in the access token response message",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "type":"string"
        },
        "error_description":{
            "type":"string"
        },
        "error_uri":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : AccessTokenErr

Type: object

Error returned in the access token response message

Show Source

• error(required): string
• error_description: string
• error_uri: string

{
    "description":"Error returned in the access token response message",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "type":"string"
        },
        "error_description":{
            "type":"string"
        },
        "error_uri":{
            "type":"string"
        }
    }
}

503 Response

Service unavailable

Body ()

Root Schema : AccessTokenErr

Type: object

Error returned in the access token response message

Show Source

• error(required): string
• error_description: string
• error_uri: string

{
    "description":"Error returned in the access token response message",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "type":"string"
        },
        "error_description":{
            "type":"string"
        },
        "error_uri":{
            "type":"string"
        }
    }
}

Default Response

Generic Error

Back to Top