COcoder
Enterprise

Update OAuth2 application.

Changed on
put/api/v2/oauth2-provider/apps/{app}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v2/oauth2-provider/apps/{app}
  • Auth
    API key in header Coder-Session-Token

Path parameters

appstring required

App ID

Request body

callback_urlstring

Deprecated: send redirect_uris instead. If both are sent, callback_url must equal the first entry of redirect_uris.

iconstring

Icon replaces the app's stored icon. Omitting it clears the stored icon rather than leaving it unchanged.

namestring required
redirect_urisstring[]

RedirectURIs is the ordered list of URIs the app may redirect to. The first entry is the primary. Omit both this and callback_url to keep the stored redirect URIs. Other fields are replaced. Sending an empty list is an error, not a way to keep the stored list.

scopestring

Scope replaces the app's current allowlist. Omit to leave the existing allowlist untouched. Set to an empty string to clear it, making the app unrestricted.

Response

OK

callback_urlstring

Deprecated: equal to the first entry of redirect_uris. Read redirect_uris instead.

client_type'confidential' | 'public'
dynamically_registeredboolean

DynamicallyRegistered is true when the app registered itself through Dynamic Client Registration rather than being created by an admin.

iconstring
idstring uuid
namestring
redirect_urisstring[]

RedirectURIs are the app's registered redirect URIs, primary first.

scopestring

Scope is the space-separated list of scopes this app's tokens may be granted. Empty means unrestricted. A non-empty value with no names is a configured allowlist that grants nothing.

Changes