Get Public Key Using GET

Get Public Key Using GET

Returns a list of public keys in jwks format. You should use this keys in your application to validate that the access-token is valid. The KID fields in the access-token is the ID of the public key. The PEM format is deprecated as it returns only the current active public key

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Anonymous ✔️ ✔️
Request
URI
GET
https://{api_host}/csp/gateway/am/api/auth/token-public-key
COPY
Query Parameters
string
format
Optional

The format for the key. Must use the 'jwks' value because The 'pem' format is deprecated. Default value will be switched to 'jwks' after deprecation

Possible values are : pem, jwks,

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PublicKeyDto of type(s) application/json
{
    "alg": "string",
    "issuer": "string",
    "keys": [
        {}
    ],
    "value": "string"
}
string
alg
Optional

The algorithm of the key.

string
issuer
Optional

The issuer of the key.

array of object
keys
Optional

The list of the keys.

string
value
Optional

The value of the key.


400

The key format can either be pem or jwks

Returns CspErrorResponse of type(s) application/json
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


404

The requested resource could not be found

Returns CspErrorResponse of type(s) application/json
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


500

An unexpected error has occurred while processing the request

Returns CspErrorResponse of type(s) application/json
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode