Updating a DKE Authorized Tenant
Use the patch /v1/cckm/microsoft/dke/auth-tenants/{id}
API to update the attributes of a Microsoft DKE authorized tenant.
Syntax
Here, {id}
is the ID of the DKE authorized tenant.
Request Parameters
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authorization token. |
authorization_type | string | Authorization type for DKE key: email and role . |
authorized_email_addresses | string | Allowed email addresses. Required field, if authorization_type is email . |
authorized_roles | string | Allowed roles in active directory. Required field, if authorization_type is set to role . |
connection | string | ID of the Azure connection. Mandatory for role-based authorization (that is, when role_authz_params is set). Refer to DKE Authorization Parameters. |
description | string | Description for the authorized tenant. |
name | string | Unique name 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
This example request shows the attributes of the DKE authorized tenant with the ID of d27d849e-e487-4b0e-a54c-a71e67687d10
is updated.
Example Response
This sample output shows the attributes of the DKE endpoint with the ID of f222ffdf-80e1-4fd5-8f17-1b60a26dba5d'
is updated.
Response Codes
Response Code | Description |
---|---|
2xx | Success |
4xx | Client errors |
5xx | Server errors |
Refer to HTTP status codes for details.