OrganizationDeletePreviewDto

Example

JSON

{
  "organization_id": "string",
  "version": 0,
  "people_named": false,
  "members": {
    "total": 0,
    "sample": [
      {
        "id": "string",
        "first_name": "string",
        "last_name": "string",
        "name": "string",
        "email": "string",
        "avatar_url": "string"
      }
    ]
  },
  "assignments_removed": 0,
  "nodes_deleted": 0,
  "roles": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "invites": {
    "total": 0,
    "names": [
      "string"
    ]
  },
  "domains": [
    "string"
  ],
  "sso_bindings": [
    "string"
  ],
  "sso_connections": [
    "string"
  ],
  "machine_clients": [
    "string"
  ],
  "directory": false
}

Properties

13 properties 13 required

organization_id string Required

version number Required

The organization's version now: send it as `If-Match` on the delete

people_named boolean Required

Whether people are named: false for a reader who may not see the Environment's people

members PreviewMembersDto Required

assignments_removed number Required

nodes_deleted number Required

Nodes beneath the organization

roles array of PreviewNodeDto Required

The organization's own roles

invites object Required

Pending invitations revoked, by email (none listed unless `people_named`)

domains array of string Required

Verified domains released

sso_bindings array of string Required

The connections bound to it for sign-in, by name

sso_connections array of string Required

The connections it owns, by name

machine_clients array of string Required

Machine clients, by name

directory boolean Required

Whether a directory connection goes with it

Was this page helpful?

Tell us how we can improve this guide.