PUT client-app/…

Updates the details of a specific registered client app.

Resource URL

https://www.drillster.com/api/2.1.1/client-app/{client_id}

Parameters

Field Type Description
client_id
required		 String The client ID.

Example value: 874a16d4ac764ce4a545f0cca4584c63
name
required		 String The name of the client application.

Example value: Integration with LMS
description
optional		 String A description of the client application.

Example value: Provides an integration with LMS.
redirectionEndpoint
required		 String The OAuth redirection endpoint. See also the OAuth documentation.
url
optional		 String An optional URL for more information about the client app.

Example value: https://www.example.com
iconKey
optional		 String An optional key for an icon that may have just been uploaded.

If a PUT request has no body (i.e. the body is empty), it is still mandatory to include a Content-Length header (i.e. Content-Length: 0). Not all HTTP clients do this automatically. For more information, please see RFC 2616.

Response

The updated 2.1.1 ClientApp object.

Error responses

The following error situations are possible:

ID Response code Description
missing_client_id 400 (Bad request) No client ID given
not_found 404 (Not found) Client application not found
not_permitted 403 (Forbidden) Caller is not permitted to change client application
invalid_name 400 (Bad request) Client application name is not valid
invalid_redirection_uri 400 (Bad request) Given redirection URI is not valid
invalid_application_url 400 (Bad request) Given application URL is not valid
not_permitted 403 (Forbidden) Not permitted to change client app status
invalid_status 400 (Bad request) Given status is not valid

 

Last updated on