Open in Claude Open in ChatGPT

Tenant

An Object

Table of Contents
Note

Drop in one of our language drivers to accelerate your development.
Here are links to some of our popular Cookbooks to help you get started!

Parent

This Tenant is contained within a Registrar.

Properties

The following properties are available:

Property Type Default Read-Only Description
_doc string No The primary ID
_system object No Metadata maintained by the system
deployedApplicationCount number No
dnsSlug string No
domainId string No
enabled boolean No
planKey string No
platformId string No
principalId string No
subtenantCount number No

Methods

The following methods are available:

Calculate Tenant

POST /registrars/{registrarId}/tenants/{tenantId}/calculate

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
tenantId true string The ID of the tenant

Check Permission

Checks whether one or more authorities against the specified tenant are granted for a given set of users
POST /registrars/{registrarId}/tenants/{permissionedId}/permissions/{permissionId}/check

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
permissionedId true string The ID of the permissioned object or datastore
permissionId true string The ID of the permission
id true string

Response

{
  "$ref": "#/components/schemas/checkPermission"
}

Check Single Authority

Checks whether a single authority is granted against the specified tenant for the given user
POST /registrars/{registrarId}/tenants/{permissionedId}/authorities/{authorityId}/check

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
permissionedId true string The ID of the permissioned object or datastore
authorityId true string The ID or authority key for the authority
id true string

Response

{
  "type": "object",
  "description": "Check",
  "extends": "status",
  "properties": {
    "check": {
      "type": "boolean"
    },
    "ok": null
  }
}

Check multiple Authorities

Checks whether one or more authorities against the specified tenant are granted for a given set of users
POST /registrars/{registrarId}/tenants/authorities/check

Parameters

Name Required Type Description
registrarId true string The ID of the registrar

Response

{
  "type": "object",
  "description": "Check Multiple Authorities Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "authorityId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Check multiple Permissions

Checks whether one or more permissions against the specified tenant are granted for a given set of users
POST /registrars/{registrarId}/tenants/permissions/check

Parameters

Name Required Type Description
registrarId true string The ID of the registrar

Response

{
  "type": "object",
  "description": "Check Multiple Permissions Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "permissionId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Closeout Tenant

POST /registrars/{registrarId}/tenants/{tenantId}/closeout

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
tenantId true string The ID of the tenant

Create Attachment

POST /registrars/{registrarId}/tenants/{tenantId}/attachments

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
tenantId true string The ID of the tenant

Create Tenant

Creates a new Tenant
POST /registrars/{registrarId}/tenants

Parameters

Name Required Type Description
registrarId true string The ID of the registrar

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Delete Attachment

DELETE /registrars/{registrarId}/tenants/{tenantId}/attachments/{attachmentId}

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
tenantId true string The ID of the tenant
attachmentId true string

Delete Tenant

Deletes an existing Tenant
DELETE /registrars/{registrarId}/tenants/{tenantId}

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
tenantId true string The ID of the tenant

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Delete Tenant

Deletes an existing Tenant
POST /registrars/{registrarId}/tenants/{tenantId}/delete

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
tenantId true string The ID of the tenant

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Export Tenant

Starts an export job for this resource
POST /registrars/{registrarId}/tenants/{tenantId}/export

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
tenantId true string The ID of the tenant
groupId false string The Group ID to be assigned to the exported archive
artifactId false string The Artifact ID to be assigned to the exported archive
versionId false string The Version ID to be assigned to the exported archive
vaultId false string The ID of the vault where the exported archive should be saved
schedule false string Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous')

Response

{
  "type": "object",
  "description": "Export Configuration",
  "properties": {
    "startDate": {
      "type": "object",
      "description": "Only include objects whose modification date is after this time (epoch millis). This is used for partial or rolling exports."
    },
    "endDate": {
      "type": "object",
      "description": "Only include objects whose modification date is before this time (epoch millis). This is used for partial or rolling exports."
    },
    "startChangeset": {
      "type": "string",
      "description": "Only include data that is relevant to changesets at or beyond the specified changeset."
    },
    "endChangeset": {
      "type": "string",
      "description": "Only include data that is relevant to changesets at or before the specified changeset."
    },
    "includeACLs": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include ACLs during export."
    },
    "includeTeams": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Teams during export."
    },
    "includeActivities": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Activities during export."
    },
    "includeBinaries": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Binaries for data stores during export."
    },
    "includeAttachments": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Attachments for Attachables during export."
    },
    "artifactDependencies": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "artifactIncludes": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "forceIncludes": {
      "type": "boolean"
    }
  }
}

Grant Authority

Grants an authority against the specified tenant to a given user
POST /registrars/{registrarId}/tenants/{permissionedId}/authorities/{authorityId}/grant

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
permissionedId true string The ID of the permissioned object or datastore
authorityId true string The ID or authority key for the authority
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Import Tenant

Starts an import job for this resource
POST /registrars/{registrarId}/tenants/{tenantId}/import

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
tenantId true string The ID of the tenant
groupId false string The Group ID to be assigned to the exported archive
artifactId false string The Artifact ID to be assigned to the exported archive
versionId false string The Version ID to be assigned to the exported archive
vaultId false string The ID of the vault where the exported archive should be saved
schedule false string Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous')

Response

{
  "type": "object",
  "description": "Import Configuration",
  "properties": {
    "includeACLs": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include ACLs during import."
    },
    "includeTeams": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Teams during import."
    },
    "includeActivities": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Activities during import."
    },
    "includeBinaries": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Binaries for data stores during import."
    },
    "includeAttachments": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Attachments for Attachables during import."
    },
    "strategy": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "default": "CLONE",
      "description": "Either CLONE or COPY_EVERYTHING. Use CLONE to keep the same IDs on import. Use COPY_EVERYTHING to generate all new IDs for all entries on every import."
    },
    "substitutions": {
      "type": "string"
    }
  }
}

List Attachments

GET /registrars/{registrarId}/tenants/{tenantId}/attachments

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
tenantId true string The ID of the tenant

List Autoclientmappings

GET /registrars/{registrarId}/tenants/{tenantId}/autoclientmappings

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
tenantId true string The ID of the tenant

List Meters

GET /registrars/{registrarId}/tenants/{tenantId}/meters

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
tenantId true string The ID of the tenant

List Objects

GET /registrars/{registrarId}/tenants/{tenantId}/objects

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
tenantId true string The ID of the tenant
type false string

Lists Tenant

Retrieves a list of Tenant instances
GET /registrars/{registrarId}/tenants

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set
This method supports pagination.

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_tenant"
      }
    }
  }
}

Lookup Tenants

GET /registrars/{registrarId}/tenants/lookup

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
id true string

Queries for Tenant

Queries for instances of type Tenant
POST /registrars/{registrarId}/tenants/query

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set
This method supports pagination.

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_tenant"
      }
    }
  }
}

Query

Queries for matches
POST /registrars/{registrarId}/tenants/{tenantId}/meters/query

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
tenantId true string The ID of the tenant
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set
This method supports pagination.

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap"
      }
    }
  }
}

Read ACL

Read the Access Control List for the specified tenant
GET /registrars/{registrarId}/tenants/{tenantId}/acl/list

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
tenantId true string The ID of the tenant

Response

{
  "type": "object",
  "description": "Result Map of ACL entries",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "_doc": {
            "type": "string",
            "title": "Principal ID"
          },
          "name": {
            "type": "string",
            "title": "Principal Name"
          },
          "type": {
            "type": "string",
            "title": "Principal Type"
          },
          "domainId": {
            "type": "string"
          },
          "domainQualifiedId": {
            "type": "string"
          },
          "domainQualifiedName": {
            "type": "string"
          },
          "principalId": {
            "type": "string",
            "title": "Principal ID"
          },
          "userEmail": {
            "type": "string"
          },
          "userFirstName": {
            "type": "string"
          },
          "userLastName": {
            "type": "string"
          },
          "authorities": {
            "type": "array",
            "title": "Authorities",
            "items": {
              "type": "string",
              "title": "Authority Key"
            }
          }
        }
      }
    }
  }
}

Read ACL for Principal

Reads the ACL for a tenant and specific actor
GET /registrars/{registrarId}/tenants/{tenantId}/acl

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
tenantId true string The ID of the tenant
id true string

Response

{
  "type": "object",
  "description": "Result Map of Authority Keys",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Authority Key"
      }
    }
  }
}

Read Attachment

GET /registrars/{registrarId}/tenants/{tenantId}/attachments/{attachmentId}

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
tenantId true string The ID of the tenant
attachmentId true string

Read Authorities Report

Read the Authorities Report for the specified tenant
POST /registrars/{registrarId}/tenants/{permissionedId}/authorities

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
permissionedId true string The ID of the permissioned object or datastore

Response

{
  "type": "object",
  "description": "Authority Report",
  "properties": {
    "principalId": {
      "type": "object",
      "properties": {
        "id": {
          "type": "object",
          "properties": {
            "role-key": {
              "type": "string"
            },
            "principal": {
              "type": "string"
            },
            "permissioned": {
              "type": "string"
            },
            "inheritsFrom": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "principal": {
                  "type": "string"
                },
                "permissioned": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

Read Defaultclient Tenant

GET /registrars/{registrarId}/tenants/{tenantId}/defaultclient

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
tenantId true string The ID of the tenant

Read Meter

GET /registrars/{registrarId}/tenants/{tenantId}/meters/{key}

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
tenantId true string The ID of the tenant
key true string

Read Tenant

Reads an instance of a Tenant
GET /registrars/{registrarId}/tenants/{tenantId}

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
tenantId true string The ID of the tenant

Response

{
  "type": "object",
  "extends": "document",
  "container": "registrar",
  "description": "Tenant",
  "properties": {
    "platformId": {
      "type": "string"
    },
    "domainId": {
      "type": "string"
    },
    "principalId": {
      "type": "string"
    },
    "planKey": {
      "type": "string"
    },
    "dnsSlug": {
      "type": "string"
    },
    "subtenantCount": {
      "type": "number"
    },
    "deployedApplicationCount": {
      "type": "number"
    },
    "enabled": {
      "type": "boolean"
    },
    "_doc": null,
    "_system": null
  }
}

Revoke Authority

Revokes an authority against the specified tenant from a given user
POST /registrars/{registrarId}/tenants/{permissionedId}/authorities/{authorityId}/revoke

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
permissionedId true string The ID of the permissioned object or datastore
authorityId true string The ID or authority key for the authority
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Start Tenants

POST /registrars/{registrarId}/tenants/start

Parameters

Name Required Type Description
registrarId true string The ID of the registrar

Update Attachment

POST /registrars/{registrarId}/tenants/{tenantId}/attachments/{attachmentId}

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
tenantId true string The ID of the tenant
attachmentId true string

Update Tenant

Updates an existing Tenant
POST /registrars/{registrarId}/tenants/{tenantId}/update

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
tenantId true string The ID of the tenant

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Update Tenant

Updates an existing Tenant
PUT /registrars/{registrarId}/tenants/{tenantId}

Parameters

Name Required Type Description
registrarId true string The ID of the registrar
tenantId true string The ID of the tenant

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Schema


{
  "type": "object",
  "extends": "document",
  "container": "registrar",
  "description": "Tenant",
  "properties": {
    "platformId": {
      "type": "string"
    },
    "domainId": {
      "type": "string"
    },
    "principalId": {
      "type": "string"
    },
    "planKey": {
      "type": "string"
    },
    "dnsSlug": {
      "type": "string"
    },
    "subtenantCount": {
      "type": "number"
    },
    "deployedApplicationCount": {
      "type": "number"
    },
    "enabled": {
      "type": "boolean"
    },
    "_doc": null,
    "_system": null
  },
  "id": "tenant"
}