DS Server

PATCH /admin/securityprofiles/{id}/clientcredentials/authorizedredirecturis

Endpoint

PATCH https://example.com/admin/securityprofiles/{id}/clientcredentials/authorizedredirecturis

Description

Specifies the authorized redirect URIs for a security profile based on a given ID.

Examples

The following sample sets two authorized redirect URIs for the security profile with the ID 3.

# Request:
curl --request PATCH 'https://trial.dsserver.io/admin/securityprofiles/3/clientcredentials/authorizedredirecturis' \
    --header 'Authorization: Basic YWRtaW46YWRtaW5hZG1pbg==' \
    --header 'Content-Type: application/json' \
    --data-raw '[
        "https://localhost:5001/textcontrol/documenteditor/auth/callback",
        "https://localhost:5001/textcontrol/documentviewer/auth/callback"
    ]'

# Response:
HTTP/1.1 200 OK

Authorization

This endpoint supports the Basic authorization method:

Basic

Header field	Description
Authorization	The username "admin" and your admin password are combined into a string separated by a colon, e.g.: admin:password. The resulting string is encoded using the RFC2045-MIME variant of Base64, except not limited to 76 char/line. The authorization method and a space i.e. "Basic " is then put before the encoded string. For example: `Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l`

Request Payload

Type	Value
String[]	An array of authorized redirect URIs as a JSON array (`application/json`). It replaces the current list; an empty array `[]` removes all redirect URIs.

Success Response

Status	Description
200	On success, the HTTP status code in the response header is 200 (OK).

Error Response

Status	Description
401	A 401 (Unauthorized) is returned, if the user is not authorized.
400	A 400 (Bad Request) is returned, if an entry of the array isn't a valid URI. The body is the plain text "One of the specified redirect URIs is invalid." The current list stays unchanged.
404	A 404 (Not Found) with an empty body is returned, if the given ID doesn't match an existing security profile.
415	A 415 (Unsupported Media Type) is returned, if the `Content-Type` header isn't `application/json`.
500	A 500 (Internal Server Error) is returned, if the body is missing, `null` or not a JSON array.