Updating a DKE Endpoint
Use the patch /v1/cckm/microsoft/dke/endpoints/{id}
API to update the attributes of a Microsoft DKE endpoint.
Syntax
Here, {id}
is the ID of the DKE endpoint.
Request Parameters
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authorization token. |
auth_tenants (optional) | string | List of IDs of authorized tenants for the DKE endpoint. |
description (optional) | string | Description for the endpoint. |
enable_success_audit_event (optional) | boolean | Enable or disable audit recording of successful operations. Default value is true. |
key_uri_hostname (optional) | string | Base url hostname for KeyURI. |
meta (optional) | JSON | Additional information associated with this endpoint. |
name (optional) | string | Unique name for the endpoint. |
DKE Authorization Parameters
Parameter | Type | Description |
---|---|---|
authorization_type | string | Authorization type for DKE key: email and role . |
email_authz_params | string | Parameters for email-based authorization. Required field, if authorization_type is email . |
authorized_email_addresses | string | Allowed email addresses. Required field, if authorization_type is email . |
role_authz_params | string | Parameters for role-based authorization. Required field, if authorization_type is set to role . Also, specify connection . Refer to Request Parameters. |
authorized_roles | string | Allowed roles in active directory. Required field, if authorization_type is set to role . |
valid_issuers | string | A valid issuer for the DKE endpoint. For example, https://sts.windows.net/azure tenant ID/ . This issuer must match the issuer within the JWT that the CCKM receives. |
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 endpoint with the ID of f222ffdf-80e1-4fd5-8f17-1b60a26dba5d
is updated to now use maria_updated@test.com
and mark_updated@test.com
as the authorized email addresses and updated demo dke endpoint 7
as the revised description for the endpoint. Also, the valid issuer is now revised to https://sts.windows.net/9c99431e-b513-44be-a7d9-e7b500002dbc/
.
Example Response
This sample output shows the attributes of the DKE endpoint with the ID of f222ffdf-80e1-4fd5-8f17-1b60a26dba5d'
is updated to now use maria_updated@test.com
and mark_updated@test.com
as the authorized email addresses and updated demo dke endpoint 7
as the revised description for the endpoint. Also, the valid issuer is now revised to https://sts.windows.net/9c99431e-b513-44be-a7d9-e7b500002dbc/
.
Response Codes
Response Code | Description |
---|---|
2xx | Success |
4xx | Client errors |
5xx | Server errors |
Refer to HTTP status codes for details.