GitHub · JSON Structure

Github Scim User Response Structure

user-response from GitHub API

Type: object Properties: 8 Required: 3
CodePipelinesPlatformSoftware DevelopmentSource ControlT1

user-response is a JSON Structure definition published by GitHub, describing 8 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

schemas externalId active userName name displayName emails roles

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/github/refs/heads/main/json-structure/github-scim-user-response-structure.json",
  "name": "user-response",
  "description": "user-response from GitHub API",
  "type": "object",
  "properties": {
    "schemas": {
      "type": "array",
      "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.",
      "items": {
        "type": "string",
        "enum": [
          "urn:ietf:params:scim:schemas:core:2.0:User"
        ]
      },
      "example": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ]
    },
    "externalId": {
      "type": "string",
      "description": "A unique identifier for the resource as defined by the provisioning client.",
      "example": "E012345",
      "nullable": true
    },
    "active": {
      "type": "boolean",
      "description": "Whether the user active in the IdP.",
      "example": true
    },
    "userName": {
      "type": "string",
      "description": "The username for the user.",
      "example": "E012345"
    },
    "name": {
      "$ref": "#/components/schemas/user-name-response"
    },
    "displayName": {
      "type": "string",
      "description": "A human-readable name for the user.",
      "example": "Mona Lisa",
      "nullable": true
    },
    "emails": {
      "$ref": "#/components/schemas/user-emails-response"
    },
    "roles": {
      "$ref": "#/components/schemas/user-role"
    }
  },
  "required": [
    "schemas",
    "active",
    "emails"
  ]
}