Cyan Web API - Version 1

GET api/tenants?{accessKey}

            Gets a Tenant by AccessKey.

Request Information

Parameters

Name	Description	Additional information
accessKey		Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "tenantId": "df6c7f07-4dd3-43ef-bb96-ba828549a98b",
  "parentTenantId": "9be5596d-f174-4abb-ba41-ee3012799afa",
  "lookupKey": "sample string 2",
  "name": "sample string 3",
  "description": "sample string 4",
  "accessKey": "sample string 5",
  "enrollmentId": "sample string 6",
  "enrollmentPassword": "sample string 7",
  "recoveryUrl": "sample string 8",
  "createdDateUtc": "2025-09-13T07:31:42.9133011+00:00",
  "updatedDateUtc": "2025-09-13T07:31:42.9133011+00:00"
}

application/xml, text/xml

Sample:

<TenantRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
  <CreatedDateUtc>2025-09-13T07:31:42.9133011+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-09-13T07:31:42.9133011+00:00</UpdatedDateUtc>
  <AccessKey>sample string 5</AccessKey>
  <Description>sample string 4</Description>
  <EnrollmentId>sample string 6</EnrollmentId>
  <EnrollmentPassword>sample string 7</EnrollmentPassword>
  <LookupKey>sample string 2</LookupKey>
  <Name>sample string 3</Name>
  <ParentTenantId>9be5596d-f174-4abb-ba41-ee3012799afa</ParentTenantId>
  <RecoveryUrl>sample string 8</RecoveryUrl>
  <TenantId>df6c7f07-4dd3-43ef-bb96-ba828549a98b</TenantId>
</TenantRepresentation>