Update an Application
patch
/api/v2/applications/{id}/
Make a PUT or PATCH request to this resource to update this application. The following fields may be modified:
name
: Name of this application. (string, required)-
description
: Optional description of this application. (string, default=""
) -
client_type
: Set to Public or Confidential depending on how secure the client device is. (choice, required)confidential
: Confidentialpublic
: Public
redirect_uris
: Allowed URIs list, space separated (string, default=""
)authorization_grant_type
: The Grant type the user must use for acquire tokens for this application. (choice, required)authorization-code
: Authorization codepassword
: Resource owner password-based
skip_authorization
: Set True to skip authorization step for completely trusted applications. (boolean, default=False
)organization
: Organization containing this application. (id, required)
For a PATCH request, include only the fields that are being modified.
Request
Supported Media Types
- application/json
Path Parameters
Root Schema : OAuth2Application
Type:
Show Source
object
-
authorization_grant_type(required):
string
Title:
Authorization Grant Type
Allowed Values:[ "authorization-code", "password" ]
The Grant type the user must use for acquire tokens for this application. -
client_id:
string
Title:
Client id
Read Only:true
Minimum Length:1
-
client_secret:
string
Title:
Client Secret
Read Only:true
Minimum Length:1
Used for more stringent verification of access to an application when creating a token. -
client_type(required):
string
Title:
Client Type
Allowed Values:[ "confidential", "public" ]
Set to Public or Confidential depending on how secure the client device is. -
created:
string
Title:
Created
Read Only:true
-
description:
string
Title:
Description
-
id:
integer
Title:
Id
Read Only:true
-
modified:
string
Title:
Modified
Read Only:true
-
name(required):
string
Title:
Name
Maximum Length:255
-
organization(required):
integer
Title:
Organization
Organization containing this application. -
redirect_uris:
string
Title:
Redirect URIs
Allowed URIs list, space separated - related: string
-
skip_authorization:
boolean
Title:
Skip Authorization
Set True to skip authorization step for completely trusted applications. -
summary_fields:
string
Title:
Summary fields
Read Only:true
-
type:
string
Title:
Type
Read Only:true
-
url:
string
Title:
Url
Read Only:true
Response
Supported Media Types
- application/json
200 Response
Root Schema : OAuth2Application
Type:
Show Source
object
-
authorization_grant_type(required):
string
Title:
Authorization Grant Type
Allowed Values:[ "authorization-code", "password" ]
The Grant type the user must use for acquire tokens for this application. -
client_id:
string
Title:
Client id
Read Only:true
Minimum Length:1
-
client_secret:
string
Title:
Client Secret
Read Only:true
Minimum Length:1
Used for more stringent verification of access to an application when creating a token. -
client_type(required):
string
Title:
Client Type
Allowed Values:[ "confidential", "public" ]
Set to Public or Confidential depending on how secure the client device is. -
created:
string
Title:
Created
Read Only:true
-
description:
string
Title:
Description
-
id:
integer
Title:
Id
Read Only:true
-
modified:
string
Title:
Modified
Read Only:true
-
name(required):
string
Title:
Name
Maximum Length:255
-
organization(required):
integer
Title:
Organization
Organization containing this application. -
redirect_uris:
string
Title:
Redirect URIs
Allowed URIs list, space separated - related: string
-
skip_authorization:
boolean
Title:
Skip Authorization
Set True to skip authorization step for completely trusted applications. -
summary_fields:
string
Title:
Summary fields
Read Only:true
-
type:
string
Title:
Type
Read Only:true
-
url:
string
Title:
Url
Read Only:true