Creating DKE Authorized Tenants
Use the post /v1/cckm/microsoft/dke/auth-tenants
API to create a DKE authorized tenant for the Microsoft Double Key Encryption service.
Specify a unique name for the authorized tenant
Syntax
Request Parameters
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authorization token. |
authorization_type | string | Authorization type for DKE key: email and role . |
issuer | string | A valid issuer for the DKE endpoint. Currently, only one issuer is supported. For example, https://sts.windows.net/azure tenant ID/. This issuer must match the issuer within the JWT that the CCKM receives. |
name | string | Unique name for the authorized tenant. |
tenant_id | string | tenant_id for the authorized tenant. |
authorized_email_addresses (optional) | string | Allowed email addresses. Required field, if authorization_type is email . |
authorized_roles (optional) | string | Allowed roles in active directory. Required field, if authorization_type is set to role . |
connection (optional) | string | ID of the Azure connection. Mandatory for role-based authorization. |
description (optional) | string | Description for the authorized tenant. |
Note
The use of wildcards '*' and '?' are supported for email addresses. The following are examples of supported wildcard formats:
abc*@gmail.com: supports any email that starts with abc and ends with "@gmail.com".
abc@?.com: supports any email that starts with abc, contains "@" followed by at least one character and ends with ".com".
abc@?.?*: supports any email that starts with abc, contains "@" followed by at least one character, followed by the dot character (.), and ends with at least one character.
?*@gmail.com: supports any email that starts with at least one character and ends with "@gmail.com".
Example Request
Example Response
The sample output shows that the DKE authorized tenant with the name of Authorized tenent 001
and an ID of c575e91f-411d-4042-b526-b6f7e3f50f1b
along with other specified parameters is created.
Response Codes
Response Code | Description |
---|---|
2xx | Success |
4xx | Client errors |
5xx | Server errors |
Refer to HTTP status codes for details.