Skip to content

oauth2_client

Manage OAuth2 clients

Create

Path
POST /v7.0/oauth2_clients
Description
Create an OAuth2 client
Authentication required
yes
Scope
oauth2_client#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
oauth2_client
ParameterTypeRequiredDetails
name
Name
 String yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty
client_id
Client_id
 String yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty
redirect_uri
Redirect_uri
 String yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty
authorization_start_uri
Authorization start URI
 String no

Absolute HTTP(S) URI where authorization restarts after password recovery

Default: null
authorization_start_requires_user_action
Authorization start requires user action
 Boolean no

Show password recovery completion before opening an interactive authorization start URI

Default: null
is_default
Default client
 Boolean no

Use this client when an OAuth flow has no client context

Default: null
access_token_lifetime
Access_token_lifetime
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • fixed
  • renewable_manual
  • renewable_auto

Validation error message: %{value} cannot be used
access_token_seconds
Access_token_seconds
 Integer no

Default: null
refresh_token_seconds
Refresh_token_seconds
 Integer no

Default: null
issue_refresh_token
Issue_refresh_token
 Boolean no

Default: null
allow_single_sign_on
Allow_single_sign_on
 Boolean no

Default: null
client_secret
Client_secret
 String yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty

Output parameters

Layout
object
Namespace
oauth2_client
ParameterTypeDescription
id
Id
 Integer
name
Name
 String
client_id
Client_id
 String
redirect_uri
Redirect_uri
 String
authorization_start_uri
Authorization start URI
 String Absolute HTTP(S) URI where authorization restarts after password recovery
authorization_start_requires_user_action
Authorization start requires user action
 Boolean Show password recovery completion before opening an interactive authorization start URI
is_default
Default client
 Boolean Use this client when an OAuth flow has no client context
access_token_lifetime
Access_token_lifetime
 String
access_token_seconds
Access_token_seconds
 Integer
refresh_token_seconds
Refresh_token_seconds
 Integer
issue_refresh_token
Issue_refresh_token
 Boolean
allow_single_sign_on
Allow_single_sign_on
 Boolean
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Delete

Path
DELETE /v7.0/oauth2_clients/{oauth2_client_id}
Description
Authentication required
yes
Scope
oauth2_client#delete
Aliases
destroy
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/oauth2_clients
Description
List OAuth2 clients
Authentication required
yes
Scope
oauth2_client#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
oauth2_client
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000

Output parameters

Layout
object_list
Namespace
oauth2_clients
ParameterTypeDescription
id
Id
 Integer
name
Name
 String
client_id
Client_id
 String
redirect_uri
Redirect_uri
 String
authorization_start_uri
Authorization start URI
 String Absolute HTTP(S) URI where authorization restarts after password recovery
authorization_start_requires_user_action
Authorization start requires user action
 Boolean Show password recovery completion before opening an interactive authorization start URI
is_default
Default client
 Boolean Use this client when an OAuth flow has no client context
access_token_lifetime
Access_token_lifetime
 String
access_token_seconds
Access_token_seconds
 Integer
refresh_token_seconds
Refresh_token_seconds
 Integer
issue_refresh_token
Issue_refresh_token
 Boolean
allow_single_sign_on
Allow_single_sign_on
 Boolean
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Show

Path
GET /v7.0/oauth2_clients/{oauth2_client_id}
Description
Show OAuth2 client
Authentication required
yes
Scope
oauth2_client#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
oauth2_client
ParameterTypeDescription
id
Id
 Integer
name
Name
 String
client_id
Client_id
 String
redirect_uri
Redirect_uri
 String
authorization_start_uri
Authorization start URI
 String Absolute HTTP(S) URI where authorization restarts after password recovery
authorization_start_requires_user_action
Authorization start requires user action
 Boolean Show password recovery completion before opening an interactive authorization start URI
is_default
Default client
 Boolean Use this client when an OAuth flow has no client context
access_token_lifetime
Access_token_lifetime
 String
access_token_seconds
Access_token_seconds
 Integer
refresh_token_seconds
Refresh_token_seconds
 Integer
issue_refresh_token
Issue_refresh_token
 Boolean
allow_single_sign_on
Allow_single_sign_on
 Boolean
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Update

Path
PUT /v7.0/oauth2_clients/{oauth2_client_id}
Description
Authentication required
yes
Scope
oauth2_client#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
oauth2_client
ParameterTypeRequiredDetails
name
Name
 String no

Default: null
client_id
Client_id
 String no

Default: null
redirect_uri
Redirect_uri
 String no

Default: null
authorization_start_uri
Authorization start URI
 String no

Absolute HTTP(S) URI where authorization restarts after password recovery

Default: null
authorization_start_requires_user_action
Authorization start requires user action
 Boolean no

Show password recovery completion before opening an interactive authorization start URI

Default: null
is_default
Default client
 Boolean no

Use this client when an OAuth flow has no client context

Default: null
access_token_lifetime
Access_token_lifetime
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • fixed
  • renewable_manual
  • renewable_auto

Validation error message: %{value} cannot be used
access_token_seconds
Access_token_seconds
 Integer no

Default: null
refresh_token_seconds
Refresh_token_seconds
 Integer no

Default: null
issue_refresh_token
Issue_refresh_token
 Boolean no

Default: null
allow_single_sign_on
Allow_single_sign_on
 Boolean no

Default: null
client_secret
Client_secret
 String no

Default: null

Output parameters

Layout
object
Namespace
oauth2_client
ParameterTypeDescription
id
Id
 Integer
name
Name
 String
client_id
Client_id
 String
redirect_uri
Redirect_uri
 String
authorization_start_uri
Authorization start URI
 String Absolute HTTP(S) URI where authorization restarts after password recovery
authorization_start_requires_user_action
Authorization start requires user action
 Boolean Show password recovery completion before opening an interactive authorization start URI
is_default
Default client
 Boolean Use this client when an OAuth flow has no client context
access_token_lifetime
Access_token_lifetime
 String
access_token_seconds
Access_token_seconds
 Integer
refresh_token_seconds
Refresh_token_seconds
 Integer
issue_refresh_token
Issue_refresh_token
 Boolean
allow_single_sign_on
Allow_single_sign_on
 Boolean
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime