Sign in

v3

latestOpenAPI 3.0.12026-08-0474115357.9 KB

Add customers

Adds one or more customers to a service desk on behalf of jsd-nutmeg.

This endpoint is restricted to jsd-nutmeg via ASAP authentication. It provides the same capability as the public {@code POST /servicedeskapi/servicedesk/{serviceDeskId}/customer} endpoint, but does not require a User Context Token (UCT) or Connect app user \u2014 authorization is enforced entirely via the ASAP token.

No user permission checks are performed; {@code null} is passed as the acting user to bypass the permission check in the underlying service.

If any of the passed customers are already associated with the service desk, no changes will be made for those customers and the resource returns a 204 success code.

post/rest/servicedeskapi/servicedesk/{serviceDeskId}/customer/skip-permission-check

Path parameters

serviceDeskIdstring required

The ID of the service desk to add customers to. This can alternatively be a project identifier.

Request body

accountIdsstring[]

List of users, specified by account IDs, to add to or remove from a service desk.

usernamesstring[]

This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details. Use accountIds instead.

Response

The request completed successfully. No additional content will be sent in the response.

{"stackTrail":"paths:/rest/servicedeskapi/servicedesk/{serviceDeskId}/customer/skip-permission-check:post:responses:204:content:application/json:schema","oasType":"schema","type":"unknown"}