iam_base

APIs.ioEngineeringPlatform

Properties

Name Type Description
expires_on object
id object
invited_by object
invited_member_email object
invited_member_id string ID of the user to add to the organization.
invited_on object
organization_id string ID of the organization the user will be added to.
organization_name string Organization name.
roles array Roles to be assigned to this user.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-iam-base-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/iam_base",
  "title": "iam_base",
  "properties": {
    "expires_on": {
      "$ref": "#/components/schemas/iam_schemas-expires_on"
    },
    "id": {
      "$ref": "#/components/schemas/iam_invite_components-schemas-identifier"
    },
    "invited_by": {
      "$ref": "#/components/schemas/iam_invited_by"
    },
    "invited_member_email": {
      "$ref": "#/components/schemas/iam_invited_member_email"
    },
    "invited_member_id": {
      "description": "ID of the user to add to the organization.",
      "example": "5a7805061c76ada191ed06f989cc3dac",
      "maxLength": 32,
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "invited_on": {
      "$ref": "#/components/schemas/iam_invited_on"
    },
    "organization_id": {
      "description": "ID of the organization the user will be added to.",
      "example": "5a7805061c76ada191ed06f989cc3dac",
      "maxLength": 32,
      "readOnly": true,
      "type": "string"
    },
    "organization_name": {
      "description": "Organization name.",
      "example": "Cloudflare, Inc.",
      "maxLength": 100,
      "readOnly": true,
      "type": "string"
    },
    "roles": {
      "description": "Roles to be assigned to this user.",
      "items": {
        "$ref": "#/components/schemas/iam_schemas-role"
      },
      "type": "array"
    }
  },
  "required": [
    "invited_member_id",
    "organization_id"
  ],
  "type": "object"
}