Describe an org

GET /<org_name>

An org is a container of roles and data items of a customer. The client can describe it to view its org_key, org_time, or basic statistics such as the numbers of roles and data items it stores.

A customer may request the admin to delete an org. A deleted org lingers until all its roles have expired.

Request

Example

GET /<org_name>
Host: <service_address>
Authorization: <org_key>

GET /sample_org
Host: beta.useast2.registry.dkplatform.io
Authorization: randomAlphaNumericString

Param	Meaning
Authorization	The credential showing the client's permission for the request. It is the `org_key` of the org.
Host	The service address, such as "useast2.registry.dkplatform.io".
x-dk-org-time	A response header that shows the org_time after the request is executed.
"org_key"	A response field that shows the client the new org_key.
"org_name"	A response field that confirms the org name.
"is_deleted"	A flag in the response that shows whether the org has been deleted but still lingers due to some unexpired playtime.
"org_time"	A response field telling the org time right after the request is processed.
"stats"	A response field showing basic statistics of the queried org or the queried directory.
"total_role_count"	One of the basic org stats.
"total_data_item_count"	One of the basic org stats.

Response

200 OK Content-Type: application/json x-dk-org-time: <org_time> { "org_name": <string>, "org_key": <string>, "is_deleted": <bool>, "org_time": <u64>, "stats": { "total_role_count": <u32>, "total_data_item_count": <u32>, }, }	Success. The org's information is returned.
400 BAD REQUEST	Wrong format in org name, missing Authorization header, or Authorization header is empty.
404 NOT FOUND	There is no such org, or (for confidentiality concern) the authorization token is invalid.
500 INTERNAL SERVER ERROR	An unexpected error happened at the server.