Tenant API - Tenant Management

Status of an access request

Gets the updated status for a request generate using the request_access endpoint.

get/v2/tenant/request_access/{requestKey}

Request

  • Base URL: https://sender.api.kivra.com
  • URL: https://sender.api.kivra.com/v2/tenant/request_access/{requestKey}
  • Auth: oAuth2Client (defined in the document in a form this page cannot read)

Path parameters

requestKeystring hexadecimal required

The unique Key for a request

Response

Data about the requested tenant

created_atstring

Datum when the request was created in UTC format

created_bystring

ID of client that created the request

statusstring

status of the request, for instance pending, accepted or rejected

client_idunknown
client_namestring

Name of the client who created the requested tenant

tenant_namestring

Name of the requested tenant

tenant_keystring

Key of the requested tenant

Example response

{
  "created_at": "2019-05-20T12:42:29Z",
  "created_by": "client_15063298495eafd2749bb78e2f991af3ab023d13df",
  "status": "pending",
  "client_name": "Client XYZ",
  "tenant_name": "Tenant ABC",
  "tenant_key": "1424780396902ee9278b16417f8e3252c3ced28c38"
}

Changes

No recorded changes to this operation across all 1 revision of this API.