Directory

Resources you can use to get more information about the user that just finished login in with GlobaliD.

Get the public profile information of the identity by subject

get

Path parameters

substringRequired

Subject of the token

Responses

200

Public profile information of the identity

application/json

404

The identity was not found

application/json

get

HTTPcURLJavaScriptPython

GET /v1/directory/{sub} HTTP/1.1
Host: api.global.id
Accept: */*

{
  "gid_uuid": "text",
  "name": "text",
  "display_name": "text",
  "profile_photo": "text",
  "created_at": "2025-05-21T21:52:55.066Z",
  "public_key": "text",
  "country_code": "text",
  "type": "USER"
}

Get the public profile information of the identity by globalid

get

Path parameters

globalidstringRequired

GlobaliD of the user, can be retrieved from the globalid claim in the access token

Responses

200

Public profile information of the identity

application/json

404

The identity was not found

application/json

get

HTTPcURLJavaScriptPython

GET /v1/directory/profile/{globalid} HTTP/1.1
Host: api.global.id
Accept: */*

{
  "gid_uuid": "text",
  "name": "text",
  "display_name": "text",
  "profile_photo": "text",
  "created_at": "2025-05-21T21:52:55.066Z",
  "public_key": "text",
  "country_code": "text",
  "type": "USER"
}

Get the public profile image of the identity by subject

get

Path parameters

substringRequired

Subject of the access token

Responses

302

Redirect to the provided redirect_uri with an authorization code

404

Profile image not found

get

HTTPcURLJavaScriptPython

GET /v1/directory/{sub}/avatar HTTP/1.1
Host: api.global.id
Accept: */*

No content

API definitions in a OpenAPI file:

4KB

directory.yml

OpenAPI file