Jump to

• Request
• Response

Retrieve Authentication Token - Autonomous AI Database Deployments

post

[host-url]/broker/pdbcs/public/v1/token

Steps to authenticate:

1. Send a POST request with the required JSON payload to the endpoint.
2. Save the access_token and use it as your Bearer token.
3. The token expires after the amount of seconds indicated by 'expires_in'.
4. After the token expires, request a new token.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

JSON containing authentication information.

Show Source

• cloud_database_name(required): string
• database_name(required): string
• grant_type(required): string
• password(required): string
• tenant_name(required): string
• username(required): string

{
    "type":"object",
    "description":"JSON containing authentication information.",
    "required":[
        "cloud_database_name",
        "database_name",
        "grant_type",
        "password",
        "tenant_name",
        "username"
    ],
    "properties":{
        "username":{
            "type":"string"
        },
        "password":{
            "type":"string"
        },
        "database_name":{
            "type":"string"
        },
        "tenant_name":{
            "type":"string"
        },
        "cloud_database_name":{
            "type":"string"
        },
        "grant_type":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful response

Body ()

Root Schema : TokenDTO

Type: object

JSON containing access token, refresh token, and other relevant information.

Show Source

• access_token: string
• expires_in: integer (int64)
• refresh_token: string
• token_type: string

{
    "type":"object",
    "description":"JSON containing access token, refresh token, and other relevant information.",
    "properties":{
        "access_token":{
            "type":"string"
        },
        "refresh_token":{
            "type":"string"
        },
        "token_type":{
            "type":"string"
        },
        "expires_in":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Back to Top