user-response

APIs.ioEngineeringPlatform

Properties

Name Type Description
schemas array The URIs that are used to indicate the namespaces of the SCIM schemas.
externalId string A unique identifier for the resource as defined by the provisioning client.
active boolean Whether the user active in the IdP.
userName string The username for the user.
name object
displayName string A human-readable name for the user.
emails object
roles object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-user-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/user-response",
  "title": "user-response",
  "type": "object",
  "required": [
    "schemas",
    "active",
    "emails"
  ],
  "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"
    }
  }
}