Get Signing Key

Use this API to return a single OpenId Connect signing key.

The endpoint is for Signing Key administration and should not be used when extracting keys for OIDC token validation. For token validation use the https://{subdomain}.onelogin.com/oidc/2/certs endpoint to get keys.

Resource URL

https://<subdomain>.onelogin.com/oidc/2/signing_keys/:kid

Resource Parameters

kid

required

string

The unique identifier for the key to fetch. You can get a list of keys and kids values via the List Signing Keys endpoint.

Header Parameters

Authorization

required

string

Set to bearer <access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

The access token must have been generated using an API credential pair created using the scope required to call this API. This API can be called using any one of the following scopes: Manage All.

Sample Responses

200 OK
401 Unauthorized

{
    "kid": "gCo4CTRm_R1GNW_pIF9JPFNNa68IFBLxJFAaFOauhhg",
    "status": "active",
    "kty": "RSA",
    "e": "AQAB",
    "use": "sig",
    "n": "3eJH03wfu8rqAxX8EXvw4UeUXLPsPaGaGF8VcP3Gl6VI1gzvPpoc2mUIJehSVJWrjDmPg40SrBNRDBoVIsV6G1Dshxn516-F4zWYg2sNFD4QKuIqh25GFE8Le_3I2aLwu5on1hj8db-2isMpV6rCK9vX1AXgupWNoe5HW00Zibe9ic9SPdPpkJ8Q34zwSvCrRiS_vzM-RREeWIWYDkWABF7GGe2cDaTRTpSpwRFO2QsLgTm1nZzoAwu5v18vFmj19dOL86Dl61t2h2GjsnNnuDG-VIVO6IMGgji2p_G4btiqlRSZYZq5nvaW8r1IHHR-KApyibunPUpbPwh6DEcWoQ"
}

Typically, this error means that your access token value is invalid.

{
    "message": "Unauthorized",
    "statusCode": 401,
    "name": "UnauthorizedError"
}

Postman Collection

Clicking Run in Postman button navigates to the page where you can fork the collection to your workspace. Forking the collection into your workspace will enable you to contribute to the source collection using pull requests. You can also view the collection in a public workspace if you like and even import a copy of the collection using the links present on the screen.

Sample Code

cURL

Replace sample values indicated by < > with your actual values.

List Mappings

curl 'https://<subdomain>.onelogin.com/oidc/2/signing_keys/:kid' \
-X GET \
-H "Authorization: bearer <access_token>"

Have a Question?

Found a problem or a bug? Submit a support ticket.

Looking for walkthroughs or how-to guides on OneLogin's user and admin features? Check out the documentation in our Knowledge Base.

Have a product idea or request? Share it with us in our Ideas Portal.