Schemas

Component schemas from api/scim-openapi.yaml (JSON Schema 2020-12; keys sorted).

ScimEmail

{
  "additionalProperties": false,
  "properties": {
    "display": {
      "readOnly": true,
      "type": "string"
    },
    "primary": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "type": {
      "type": [
        "string",
        "null"
      ]
    },
    "value": {
      "description": "Email address.",
      "type": "string"
    }
  },
  "required": [
    "value"
  ],
  "type": "object"
}

ScimEmailWrite

{
  "additionalProperties": false,
  "properties": {
    "display": {
      "readOnly": true
    },
    "primary": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "type": {
      "type": [
        "string",
        "null"
      ]
    },
    "value": {
      "description": "Email address.",
      "type": "string"
    }
  },
  "required": [
    "value"
  ],
  "type": "object"
}

ScimError

{
  "additionalProperties": false,
  "properties": {
    "detail": {
      "type": "string"
    },
    "schemas": {
      "items": {
        "const": "urn:ietf:params:scim:api:messages:2.0:Error",
        "type": "string"
      },
      "maxItems": 1,
      "minItems": 1,
      "type": "array"
    },
    "scimType": {
      "enum": [
        "invalidFilter",
        "tooMany",
        "uniqueness",
        "mutability",
        "invalidSyntax",
        "invalidPath",
        "noTarget",
        "invalidValue",
        "invalidVers",
        "sensitive"
      ],
      "type": "string"
    },
    "status": {
      "pattern": "^[45][0-9]{2}$",
      "type": "string"
    }
  },
  "required": [
    "schemas",
    "status",
    "detail"
  ],
  "type": "object"
}

ScimGroup

{
  "additionalProperties": false,
  "properties": {
    "displayName": {
      "maxLength": 256,
      "minLength": 1,
      "type": "string"
    },
    "externalId": {
      "type": [
        "string",
        "null"
      ]
    },
    "id": {
      "minLength": 1,
      "readOnly": true,
      "type": "string"
    },
    "members": {
      "items": {
        "$ref": "#/components/schemas/ScimMember"
      },
      "type": "array"
    },
    "meta": {
      "$ref": "#/components/schemas/ScimGroupMeta",
      "readOnly": true
    },
    "schemas": {
      "$ref": "#/components/schemas/ScimGroupSchemaUris"
    }
  },
  "required": [
    "schemas",
    "id",
    "displayName",
    "members",
    "meta"
  ],
  "type": "object"
}

ScimGroupListResponse

{
  "additionalProperties": false,
  "properties": {
    "Resources": {
      "items": {
        "$ref": "#/components/schemas/ScimGroup"
      },
      "type": "array"
    },
    "itemsPerPage": {
      "maximum": 200,
      "minimum": 0,
      "type": "integer"
    },
    "schemas": {
      "items": {
        "const": "urn:ietf:params:scim:api:messages:2.0:ListResponse",
        "type": "string"
      },
      "maxItems": 1,
      "minItems": 1,
      "type": "array"
    },
    "startIndex": {
      "minimum": 1,
      "type": "integer"
    },
    "totalResults": {
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "schemas",
    "totalResults",
    "startIndex",
    "itemsPerPage",
    "Resources"
  ],
  "type": "object"
}

ScimGroupMeta

{
  "additionalProperties": false,
  "properties": {
    "created": {
      "format": "date-time",
      "type": "string"
    },
    "lastModified": {
      "format": "date-time",
      "type": "string"
    },
    "location": {
      "format": "uri",
      "type": "string"
    },
    "resourceType": {
      "const": "Group",
      "type": "string"
    }
  },
  "required": [
    "resourceType",
    "created",
    "lastModified",
    "location"
  ],
  "type": "object"
}

ScimGroupSchemaUris

{
  "items": {
    "const": "urn:ietf:params:scim:schemas:core:2.0:Group",
    "type": "string"
  },
  "maxItems": 1,
  "minItems": 1,
  "type": "array"
}

ScimGroupWrite

{
  "additionalProperties": false,
  "properties": {
    "displayName": {
      "maxLength": 256,
      "minLength": 1,
      "type": "string"
    },
    "externalId": {
      "type": [
        "string",
        "null"
      ]
    },
    "id": {
      "readOnly": true
    },
    "members": {
      "items": {
        "$ref": "#/components/schemas/ScimMemberWrite"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "meta": {
      "readOnly": true
    },
    "schemas": {
      "$ref": "#/components/schemas/ScimGroupSchemaUris"
    }
  },
  "required": [
    "schemas",
    "displayName"
  ],
  "type": "object"
}

ScimMember

{
  "additionalProperties": false,
  "properties": {
    "$ref": {
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "display": {
      "readOnly": true,
      "type": "string"
    },
    "type": {
      "anyOf": [
        {
          "const": "User",
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "value": {
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "value"
  ],
  "type": "object"
}

ScimMemberWrite

{
  "additionalProperties": false,
  "properties": {
    "$ref": {
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "display": {
      "readOnly": true
    },
    "type": {
      "anyOf": [
        {
          "const": "User",
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "value": {
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "value"
  ],
  "type": "object"
}

ScimPatchOperation

Protocol syntax only. The runtime checks supported operations, paths and value types before any mutation. Unsupported operations/paths return 501; malformed supported values return 400, never coercion or partial writes.

{
  "additionalProperties": false,
  "description": "Protocol syntax only. The runtime checks supported operations, paths and value types before any mutation. Unsupported operations/paths return 501; malformed supported values return 400, never coercion or partial writes.\n",
  "properties": {
    "op": {
      "minLength": 1,
      "type": "string"
    },
    "path": {
      "minLength": 1,
      "type": "string"
    },
    "value": {}
  },
  "required": [
    "op"
  ],
  "type": "object"
}

ScimPatchRequest

{
  "additionalProperties": false,
  "properties": {
    "Operations": {
      "items": {
        "$ref": "#/components/schemas/ScimPatchOperation"
      },
      "minItems": 1,
      "type": "array"
    },
    "schemas": {
      "items": {
        "const": "urn:ietf:params:scim:api:messages:2.0:PatchOp",
        "type": "string"
      },
      "maxItems": 1,
      "minItems": 1,
      "type": "array"
    }
  },
  "required": [
    "schemas",
    "Operations"
  ],
  "type": "object"
}

ScimServiceProviderConfig

{
  "additionalProperties": false,
  "properties": {
    "authenticationSchemes": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "description": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "primary": {
            "const": true,
            "type": "boolean"
          },
          "type": {
            "const": "oauthbearertoken",
            "type": "string"
          }
        },
        "required": [
          "type",
          "name",
          "description",
          "primary"
        ],
        "type": "object"
      },
      "maxItems": 1,
      "minItems": 1,
      "type": "array"
    },
    "bulk": {
      "additionalProperties": false,
      "properties": {
        "maxOperations": {
          "const": 0,
          "type": "integer"
        },
        "maxPayloadSize": {
          "const": 0,
          "type": "integer"
        },
        "supported": {
          "const": false,
          "type": "boolean"
        }
      },
      "required": [
        "supported",
        "maxOperations",
        "maxPayloadSize"
      ],
      "type": "object"
    },
    "changePassword": {
      "$ref": "#/components/schemas/ScimUnsupportedCapability"
    },
    "documentationUri": {
      "format": "uri",
      "type": "string"
    },
    "etag": {
      "$ref": "#/components/schemas/ScimUnsupportedCapability"
    },
    "filter": {
      "additionalProperties": false,
      "properties": {
        "maxResults": {
          "const": 200,
          "type": "integer"
        },
        "supported": {
          "const": true,
          "type": "boolean"
        }
      },
      "required": [
        "supported",
        "maxResults"
      ],
      "type": "object"
    },
    "patch": {
      "additionalProperties": false,
      "properties": {
        "supported": {
          "const": true,
          "type": "boolean"
        }
      },
      "required": [
        "supported"
      ],
      "type": "object"
    },
    "schemas": {
      "items": {
        "const": "urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig",
        "type": "string"
      },
      "maxItems": 1,
      "minItems": 1,
      "type": "array"
    },
    "sort": {
      "$ref": "#/components/schemas/ScimUnsupportedCapability"
    }
  },
  "required": [
    "schemas",
    "patch",
    "bulk",
    "filter",
    "changePassword",
    "sort",
    "etag",
    "authenticationSchemes"
  ],
  "type": "object"
}

ScimUnsupportedCapability

{
  "additionalProperties": false,
  "properties": {
    "supported": {
      "const": false,
      "type": "boolean"
    }
  },
  "required": [
    "supported"
  ],
  "type": "object"
}

ScimUser

{
  "additionalProperties": false,
  "properties": {
    "active": {
      "description": "Only true grants membership access; null is unassigned and denies access.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "displayName": {
      "type": [
        "string",
        "null"
      ]
    },
    "emails": {
      "items": {
        "$ref": "#/components/schemas/ScimEmail"
      },
      "type": "array"
    },
    "externalId": {
      "type": [
        "string",
        "null"
      ]
    },
    "id": {
      "minLength": 1,
      "readOnly": true,
      "type": "string"
    },
    "meta": {
      "$ref": "#/components/schemas/ScimUserMeta",
      "readOnly": true
    },
    "name": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/ScimUserName"
        },
        {
          "type": "null"
        }
      ]
    },
    "schemas": {
      "$ref": "#/components/schemas/ScimUserSchemaUris"
    },
    "userName": {
      "description": "Email address; unique per organization, compared case-insensitively.",
      "type": "string"
    }
  },
  "required": [
    "schemas",
    "id",
    "userName",
    "active",
    "meta"
  ],
  "type": "object"
}

ScimUserListResponse

{
  "additionalProperties": false,
  "properties": {
    "Resources": {
      "items": {
        "$ref": "#/components/schemas/ScimUser"
      },
      "type": "array"
    },
    "itemsPerPage": {
      "maximum": 200,
      "minimum": 0,
      "type": "integer"
    },
    "schemas": {
      "items": {
        "const": "urn:ietf:params:scim:api:messages:2.0:ListResponse",
        "type": "string"
      },
      "maxItems": 1,
      "minItems": 1,
      "type": "array"
    },
    "startIndex": {
      "minimum": 1,
      "type": "integer"
    },
    "totalResults": {
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "schemas",
    "totalResults",
    "startIndex",
    "itemsPerPage",
    "Resources"
  ],
  "type": "object"
}

ScimUserMeta

{
  "additionalProperties": false,
  "properties": {
    "created": {
      "format": "date-time",
      "type": "string"
    },
    "lastModified": {
      "format": "date-time",
      "type": "string"
    },
    "location": {
      "format": "uri",
      "type": "string"
    },
    "resourceType": {
      "const": "User",
      "type": "string"
    }
  },
  "required": [
    "resourceType",
    "created",
    "lastModified",
    "location"
  ],
  "type": "object"
}

ScimUserName

{
  "additionalProperties": false,
  "properties": {
    "familyName": {
      "type": [
        "string",
        "null"
      ]
    },
    "formatted": {
      "type": [
        "string",
        "null"
      ]
    },
    "givenName": {
      "type": [
        "string",
        "null"
      ]
    },
    "honorificPrefix": {
      "type": [
        "string",
        "null"
      ]
    },
    "honorificSuffix": {
      "type": [
        "string",
        "null"
      ]
    },
    "middleName": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "type": "object"
}

ScimUserSchemaUris

{
  "items": {
    "const": "urn:ietf:params:scim:schemas:core:2.0:User",
    "type": "string"
  },
  "maxItems": 1,
  "minItems": 1,
  "type": "array"
}

ScimUserWrite

{
  "additionalProperties": false,
  "properties": {
    "active": {
      "description": "No schema default; preserve omission for operation-specific runtime semantics.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "displayName": {
      "type": [
        "string",
        "null"
      ]
    },
    "emails": {
      "items": {
        "$ref": "#/components/schemas/ScimEmailWrite"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "externalId": {
      "type": [
        "string",
        "null"
      ]
    },
    "id": {
      "readOnly": true
    },
    "meta": {
      "readOnly": true
    },
    "name": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/ScimUserName"
        },
        {
          "type": "null"
        }
      ]
    },
    "schemas": {
      "$ref": "#/components/schemas/ScimUserSchemaUris"
    },
    "userName": {
      "description": "Email address; unique per organization, compared case-insensitively.",
      "type": "string"
    }
  },
  "required": [
    "schemas",
    "userName"
  ],
  "type": "object"
}