Skip to content

user_session

Browse user sessions

Close

Path
POST /v7.0/user_sessions/{user_session_id}
Description
Close user session, revoke access token
Authentication required
yes
Scope
user_session#close
Aliases
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Create

Path
POST /v7.0/user_sessions
Description
Create a new session for token authentication
Authentication required
yes
Scope
user_session#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
user_session
ParameterTypeRequiredDetails
user
User
 Resource yes
label
Label
 String no

Default: null
scope
Scope
 String no

Default: all
token_lifetime
Token lifetime
 String yes

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • fixed
  • renewable_manual
  • renewable_auto
  • permanent

Validation error message: %{value} cannot be used

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
token_interval
Token interval
 Integer no

Default: null

Output parameters

Layout
object
Namespace
user_session
ParameterTypeDescription
id
Id
 Integer
user
User
 Resource
label
Label
 String
auth_type
Authentication type
 String
api_ip_addr
API IP address
 String
api_ip_ptr
API IP PTR
 String
client_ip_addr
Client IP address
 String
client_ip_ptr
Client IP PTR
 String
user_agent
User agent
 String
client_version
Client version
 String
scope
Scope
 String
token_fragment
Authentication token fragment
 String
token_lifetime
Token lifetime
 String
token_interval
Token interval
 Integer
created_at
Created at
 Datetime
last_request_at
Last request at
 Datetime
request_count
Request count
 Integer
closed_at
Closed at
 Datetime
admin
Admin
 Resource Filter users with administrator privileges
token_full
Token_full
 String

Index

Path
GET /v7.0/user_sessions
Description
List user sessions
Authentication required
yes
Scope
user_session#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
user_session
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: 25

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
user
User
 Resource no
auth_type
Authentication type
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • basic
  • token
  • oauth2

Validation error message: %{value} cannot be used
api_ip_addr
API IP address
 String no

Default: null
client_ip_addr
Client IP address
 String no

Default: null
user_agent
User agent
 String no

Default: null
client_version
Client version
 String no

Default: null
token_fragment
Authentication token fragment
 String no

Default: null
admin
Admin
 Resource no

Filter users with administrator privileges
ip_addr
IP Address
 String no

Search both API and client IP address

Default: null
state
State
 String no

Default: all

Validation rules
RuleDetails
Include

Allowed values:

  • all
  • open
  • closed

Validation error message: %{value} cannot be used

Output parameters

Layout
object_list
Namespace
user_sessions
ParameterTypeDescription
id
Id
 Integer
user
User
 Resource
label
Label
 String
auth_type
Authentication type
 String
api_ip_addr
API IP address
 String
api_ip_ptr
API IP PTR
 String
client_ip_addr
Client IP address
 String
client_ip_ptr
Client IP PTR
 String
user_agent
User agent
 String
client_version
Client version
 String
scope
Scope
 String
token_fragment
Authentication token fragment
 String
token_lifetime
Token lifetime
 String
token_interval
Token interval
 Integer
created_at
Created at
 Datetime
last_request_at
Last request at
 Datetime
request_count
Request count
 Integer
closed_at
Closed at
 Datetime
admin
Admin
 Resource Filter users with administrator privileges

Show

Path
GET /v7.0/user_sessions/{user_session_id}
Description
Show a user session
Authentication required
yes
Scope
user_session#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
user_session
ParameterTypeDescription
id
Id
 Integer
user
User
 Resource
label
Label
 String
auth_type
Authentication type
 String
api_ip_addr
API IP address
 String
api_ip_ptr
API IP PTR
 String
client_ip_addr
Client IP address
 String
client_ip_ptr
Client IP PTR
 String
user_agent
User agent
 String
client_version
Client version
 String
scope
Scope
 String
token_fragment
Authentication token fragment
 String
token_lifetime
Token lifetime
 String
token_interval
Token interval
 Integer
created_at
Created at
 Datetime
last_request_at
Last request at
 Datetime
request_count
Request count
 Integer
closed_at
Closed at
 Datetime
admin
Admin
 Resource Filter users with administrator privileges

Update

Path
PUT /v7.0/user_sessions/{user_session_id}
Description
Update user session
Authentication required
yes
Scope
user_session#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
user_session
ParameterTypeRequiredDetails
label
Label
 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
user_session
ParameterTypeDescription
id
Id
 Integer
user
User
 Resource
label
Label
 String
auth_type
Authentication type
 String
api_ip_addr
API IP address
 String
api_ip_ptr
API IP PTR
 String
client_ip_addr
Client IP address
 String
client_ip_ptr
Client IP PTR
 String
user_agent
User agent
 String
client_version
Client version
 String
scope
Scope
 String
token_fragment
Authentication token fragment
 String
token_lifetime
Token lifetime
 String
token_interval
Token interval
 Integer
created_at
Created at
 Datetime
last_request_at
Last request at
 Datetime
request_count
Request count
 Integer
closed_at
Closed at
 Datetime
admin
Admin
 Resource Filter users with administrator privileges