Sign in
clients

rename security server client

<h3>Administrator renames client.</h3> <p>This endpoint can also return metadata in the error response if sending the management request fails. The metadata array contains the error details that were generated in core. The message is in plain English.</p>
put/clients/{id}/rename

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/clients/{id}/rename
  • Auth: API key in header Authorization

Path parameters

idstring text required

id of the client

Request body

client_namestring text required

Client name. Cannot contain colons, semicolons, slashes, backslashes, percent signs or control characters

Example request

{
  "client_name": "Subsystem Name"
}

Response

renaming was successful

Changes

No recorded changes to this operation across all 50 revisions of this API.