GitLab · JSON Structure

Gitlab Oauth2 User Info Structure

UserInfo from GitLab API

Type: object Properties: 8
CodePlatformSoftware DevelopmentSource Control

UserInfo is a JSON Structure definition published by GitLab, describing 8 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

sub name nickname email email_verified profile picture groups

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/gitlab/refs/heads/main/json-structure/gitlab-oauth2-user-info-structure.json",
  "name": "UserInfo",
  "description": "UserInfo from GitLab API",
  "type": "object",
  "properties": {
    "sub": {
      "type": "string",
      "description": "Subject identifier. Unique to the user within the provider.",
      "example": "example_value"
    },
    "name": {
      "type": "string",
      "description": "Full name of the user.",
      "example": "Example Project"
    },
    "nickname": {
      "type": "string",
      "description": "The user's GitLab username.",
      "example": "Example Project"
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "The user's email address. Requires the email scope.",
      "example": "user@example.com"
    },
    "email_verified": {
      "type": "boolean",
      "description": "Whether the user's email address has been verified.",
      "example": true
    },
    "profile": {
      "type": "uri",
      "description": "URL to the user's GitLab profile page.",
      "example": "example_value"
    },
    "picture": {
      "type": "uri",
      "description": "URL to the user's avatar image.",
      "example": "example_value"
    },
    "groups": {
      "type": "array",
      "description": "List of groups the user belongs to.",
      "items": {
        "type": "string"
      }
    }
  }
}