Your suggested change has been received. Thank you.

close
Thales Logo

All

  • All
  • CipherTrust Manager
  • CipherTrust Application Data Protection (CADP)
  • CipherTrust Application Key Management (CAKM)
  • CipherTrust Batch Data Transformation (BDT)
  • CipherTrust Cloud Key Management (CCKM)
  • CipherTrust Data Discovery and Classification (DDC)
  • CipherTrust Data Protection Gateway (DPG)
  • CipherTrust Database Protection (CDP)
  • CipherTrust Intelligent Protection (CIP)
  • CipherTrust Integrations
  • CipherTrust Migrations
  • CipherTrust RESTful Data Protection (CRDP)
  • CipherTrust Transparent Encryption (CTE)
  • CipherTrust Transparent Encryption Userspace (CTE-U)
  • CipherTrust Secrets Management (CSM)
  • CipherTrust Vaulted Tokenization (CT-V)
  • CipherTrust Vaultless Tokenization (CT-VL)
  • CTE-Linux
  • CTE-Windows
  • CTE-AIX
  • CTE-K8s
  • CTE-U
  • Crypto Command Center
  • Data Protection on Demand
  • Luna Cloud HSM
  • Luna Network HSM
  • Luna PCIe HSM
  • Luna USB HSM
  • OneWelcome Identity Platform
  • ProtectApp LUKS
  • ProtectServer 2 HSM
  • ProtectServer 3 HSM
  • SafeNet Trusted Access (STA)
  • SafeNet MobilePASS+
  • SafeNet MobilePASS+ for Android
  • SafeNet MobilePASS+ for Chrome
  • SafeNet MobilePASS+ for macOS
  • SafeNet MobilePASS+ for iOS
  • SafeNet MobilePASS+ for WatchOS
  • SafeNet MobilePASS+ for Windows
  • SafeNet Synchronization Agent
  • SafeNet Logging Agent
  • SafeNet Agent for FreeRADIUS
  • SafeNet Agent for NPS
  • SafeNet Agent for Windows Logon
  • SafeNet Authentication Service Private Cloud Edition (SAS PCE)
  • SafeNet Remote Logging Agent
  • SafeNet Keycloak Agent
  • SafeNet IDPrime Virtual (IDPV)
  • SafeNet FIDO Key Manager
  • SafeNet FIDO Key Manager for Android
  • SafeNet FIDO Key Manager for iOS
  • SafeNet FIDO Key Manager for Windows
back

OAuth 2.0 and OpenID Connect

User information API

search
printsuggest an editpdf paneldownload

User information API

The user information API is the implementation of UserInfo endpoint defined in the OpenID Connect Core 1.0 specification. It returns claims for the user associated with the access token that is presented via bearer authentication.

This endpoint requires bearer authentication. The token must be a valid access token with at least the openid scope. A 200 OK is returned when the user presents a valid token. Otherwise, one of the following errors is returned:

Http status code Description
401 No bearer token present in the request, the token does not exist or has expired
403 The token does not have the openid scope

Endpoints:

  • GET /oauth/v1/userinfo
  • POST /oauth/v1/userinfo

This endpoint accepts the following request parameters:

Parameter Required Example value Description
refresh_user_details no true The values of the claims from the user info endpoint (

Example request

GET /oauth/v1/userinfo HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer 792D84C0509CFC589A3F25BC55FD4A72756B191B5682956B273F2A695EC20FE9
Host: example.com

Example response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control: no-store
Pragma: no-cache

{
    "sub": "2c32f622-ecfe-42a7-a25c-7a2c674acb4f",
    "name": "John Doe",
    "preferred_username": "John Doe",
    "given_name": "John",
    "family_name": "Doe",
    "nickname": "John Doe",
    "birthdate": "1980-01-01",
    "email": "john.doe@example.com"
    "email_verified": false,
    "phone_number": "+48505500500",
    "phone_number_verified": false,
    "address": {
        "locality": "Woerden",
        "street_address": "Tjaskermolenlaan 1",
        "country": "Netherlands",
        "postal_code": "3447 GE",
        "region": "Utrecht"
    },
    "gender": "male",
    "locale": "nl"
}

On this page