WorkOS · Schema

CreateUserlandUserOrganizationMembershipDto

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP
View JSON Schema on GitHub

JSON Schema

workos-createuserlanduserorganizationmembershipdto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateUserlandUserOrganizationMembershipDto",
  "title": "CreateUserlandUserOrganizationMembershipDto",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "user_id": {
          "type": "string",
          "description": "The ID of the [user](/reference/authkit/user).",
          "example": "user_01E4ZCR3C5A4QZ2Z2JQXGKZJ9E"
        },
        "organization_id": {
          "type": "string",
          "description": "The ID of the [organization](/reference/organization) which the user belongs to.",
          "example": "org_01E4ZCR3C56J083X43JQXF3JK5"
        }
      },
      "required": [
        "user_id",
        "organization_id"
      ]
    },
    {
      "oneOf": [
        {
          "type": "object",
          "not": {
            "anyOf": [
              {
                "properties": {
                  "role_slug": {
                    "x-exclude-from-lint": true
                  }
                },
                "required": [
                  "role_slug"
                ]
              },
              {
                "properties": {
                  "role_slugs": {
                    "x-exclude-from-lint": true
                  }
                },
                "required": [
                  "role_slugs"
                ]
              }
            ]
          }
        },
        {
          "type": "object",
          "properties": {
            "role_slug": {
              "type": "string",
              "description": "A single role identifier. Defaults to `member` or the explicit default role. Mutually exclusive with `role_slugs`.",
              "example": "admin"
            }
          },
          "required": [
            "role_slug"
          ],
          "not": {
            "anyOf": [
              {
                "properties": {
                  "role_slugs": {
                    "x-exclude-from-lint": true
                  }
                },
                "required": [
                  "role_slugs"
                ]
              }
            ]
          }
        },
        {
          "type": "object",
          "properties": {
            "role_slugs": {
              "description": "An array of role identifiers. Limited to one role when Multiple Roles is disabled. Mutually exclusive with `role_slug`.",
              "example": [
                "admin"
              ],
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "required": [
            "role_slugs"
          ],
          "not": {
            "anyOf": [
              {
                "properties": {
                  "role_slug": {
                    "x-exclude-from-lint": true
                  }
                },
                "required": [
                  "role_slug"
                ]
              }
            ]
          }
        }
      ]
    }
  ],
  "x-mutually-exclusive-body-groups": {
    "role": {
      "optional": true,
      "variants": {
        "single": [
          "role_slug"
        ],
        "multiple": [
          "role_slugs"
        ]
      }
    }
  }
}