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:

Attachments

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

Parameters

Name Required Type Description
registrarId true string
tenantId true string

Response

{}

Attachments

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

Parameters

Name Required Type Description
registrarId true string
tenantId true string

Response

{}

Autoclientmappings

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

Parameters

Name Required Type Description
registrarId true string
tenantId true string

Response

{}

Calculate

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

Parameters

Name Required Type Description
registrarId true string
tenantId true string

Response

{}

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
permissionedId true string
permissionId true string
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
permissionedId true string
authorityId true string
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

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

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

Parameters

Name Required Type Description
registrarId true string
tenantId true string

Response

{}

Create Tenant

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

Parameters

Name Required Type Description
registrarId true string

Response

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

Defaultclient

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

Parameters

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

Response

{}

Delete Tenant

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

Parameters

Name Required Type Description
registrarId true string
tenantId true string

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
tenantId true string

Response

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

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
permissionedId true string
authorityId true string
id true string

Response

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

Lists Tenant

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

Parameters

Name Required Type Description
registrarId true string
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

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

GET /registrars/{registrarId}/tenants/lookup

Parameters

Name Required Type Description
registrarId true string
id true string

Response

{}

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

Response

{}

Objects

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

Parameters

Name Required Type Description
registrarId true string
tenantId true string
type false string

Response

{}

Queries for Tenant

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

Parameters

Name Required Type Description
registrarId true string
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

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
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

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
tenantId true string

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
tenantId true string
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 Authorities Report

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

Parameters

Name Required Type Description
registrarId true string
permissionedId true string

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 Tenant

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

Parameters

Name Required Type Description
registrarId true string
tenantId true string

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
permissionedId true string
authorityId true string
id true string

Response

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

Start

POST /registrars/{registrarId}/tenants/start

Parameters

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

Response

{}

Starts an export job for this resource

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

Parameters

Name Required Type Description
registrarId true string
tenantId true string
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"
    },
    "endDate": {
      "type": "object"
    },
    "startChangeset": {
      "type": "string"
    },
    "endChangeset": {
      "type": "string"
    },
    "includeACLs": {
      "type": "boolean"
    },
    "includeTeams": {
      "type": "boolean"
    },
    "includeActivities": {
      "type": "boolean"
    },
    "includeBinaries": {
      "type": "boolean"
    },
    "includeAttachments": {
      "type": "boolean"
    },
    "artifactDependencies": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "artifactIncludes": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "forceIncludes": {
      "type": "boolean"
    }
  }
}

Starts an import job for this resource

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

Parameters

Name Required Type Description
registrarId true string
tenantId true string
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"
    },
    "includeTeams": {
      "type": "boolean"
    },
    "includeActivities": {
      "type": "boolean"
    },
    "includeBinaries": {
      "type": "boolean"
    },
    "includeAttachments": {
      "type": "boolean"
    },
    "strategy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "substitutions": {
      "type": "string"
    }
  }
}

Update Tenant

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

Parameters

Name Required Type Description
registrarId true string
tenantId true string

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
tenantId true string

Response

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

{attachmentId}

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

Parameters

Name Required Type Description
registrarId true string
tenantId true string
attachmentId true string

Response

{}

{attachmentId}

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

Parameters

Name Required Type Description
registrarId true string
tenantId true string
attachmentId true string

Response

{}

{attachmentId}

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

Parameters

Name Required Type Description
registrarId true string
tenantId true string
attachmentId true string

Response

{}

{key}

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

Parameters

Name Required Type Description
registrarId true string
tenantId true string
key true string

Response

{}

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"
}