logo
API docs by Redocly

Vue Play User Authentication API (1.0.0)

Download OpenAPI specification:Download

Vue Play: support@vueplay.com URL: https://vueplay.com License: Apache 2.0

API documentation for FeathersJS service including user management and authentication

Authentication

User login

Logs in a user using credentials (local strategy) or a JWT (jwt strategy), and returns a JWT token.

Request Body schema: application/json
required
strategy
string
Default: "local"
Enum: "local" "jwt"

The authentication strategy to use. Defaults to 'local' (email/username/phone and password) if not set, or 'jwt' for token-based authentication.

email
string <email>

Can be used if logging in with email. Required if using the local strategy and username or phone are not provided.

username
string

Can be used if logging in with a username. Required if using the local strategy and email or phone are not provided.

phone
string

Can be used if logging in with a phone number. Required if using the local strategy and email or username are not provided.

password
string

Required if using the local strategy.

accessToken
string

Required if using the jwt strategy (accessToken).

Responses

Request samples

Content type
application/json
{
  • "strategy": "local",
  • "email": "user@example.com",
  • "username": "string",
  • "phone": "string",
  • "password": "string",
  • "accessToken": "string"
}

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "user": {
    }
}

User login - OAuth

Redirects to the OAuth provider (Facebook, GitHub, Google) for authentication.

path Parameters
provider
required
string
Enum: "facebook" "github" "google"

Responses

One Time Password Request

Creates a new one time password.

Request Body schema: application/json
required

Email or phone number to receive OTP

One of
email
string

Responses

Request samples

Content type
application/json
{
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

User login - One Time Password

Exchanges a one time password with an access token.

path Parameters
otp
required
string
Request Body schema: application/json
required

Email or phone number to receiver

One of
email
string

Responses

Request samples

Content type
application/json
{
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Authentication Providers

Retrieve a list of authentication providers

Returns a list of authentication providers.

Authorizations:
bearerAuth

Responses

Request samples 

app.service('oauth_providers').find({ query: {} })

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Create a new authentication provider

Creates a new authentication provider based on the provided object.

Authorizations:
bearerAuth
Request Body schema: application/json
required

Authentication Provider object that needs to be added

name
string or null
slug
required
string
key
string or null
secret
string or null
scope
string or null
nonce
boolean or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "slug": "string",
  • "key": "string",
  • "secret": "string",
  • "scope": "string",
  • "nonce": false
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "slug": "string",
  • "key": "string",
  • "secret": "string",
  • "scope": "string",
  • "nonce": false,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an authentication provider by ID

Retrieves an authentication provider based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Request samples 

const id = 0
app.service('oauth_providers').get(id)

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "slug": "string",
  • "key": "string",
  • "secret": "string",
  • "scope": "string",
  • "nonce": false,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update an authentication provider by ID

Updates an authentication provider based on the provided ID and object.

Authorizations:
bearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
required

Authentication provider object that needs to be updated

name
string or null
slug
required
string
key
string or null
secret
string or null
scope
string or null
nonce
boolean or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "slug": "string",
  • "key": "string",
  • "secret": "string",
  • "scope": "string",
  • "nonce": false
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "slug": "string",
  • "key": "string",
  • "secret": "string",
  • "scope": "string",
  • "nonce": false,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Patch an authentication provider by ID

Patches an authentication provider based on the provided ID and object.

Authorizations:
bearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
required

Authentication provider object that needs to be updated

name
string or null
slug
required
string
key
string or null
secret
string or null
scope
string or null
nonce
boolean or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "slug": "string",
  • "key": "string",
  • "secret": "string",
  • "scope": "string",
  • "nonce": false
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "slug": "string",
  • "key": "string",
  • "secret": "string",
  • "scope": "string",
  • "nonce": false,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete an authentication provider by ID

Deletes an authentication provider based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "slug": "string",
  • "key": "string",
  • "secret": "string",
  • "scope": "string",
  • "nonce": false,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Authentication Sessions

Retrieve a list of Authentication Sessions

Returns a list of Authentication Sessions.

Authorizations:
bearerAuth

Responses

Request samples 

app.service('auth_sessions').find({ query: {} })

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Create a new authentication session

Creates a new authentication session based on the provided object.

Authorizations:
bearerAuth
Request Body schema: application/json
required

Authentication session object that needs to be added

title
string
user_id
required
integer
auth_provider
string
ip
string
hostname
string
city
string
region
string
country
string
loc
string
org
string
postal
string
timezone
string
useragent
string
browser_name
string
browser_version
string
engine_name
string
engine_version
string
device_vendor
string
device_model
string
device_type
string
os_name
string
os_version
string
cpu_arch
string
encrypted_token
string
revoked
boolean

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "user_id": 0,
  • "auth_provider": "string",
  • "ip": "string",
  • "hostname": "string",
  • "city": "string",
  • "region": "string",
  • "country": "string",
  • "loc": "string",
  • "org": "string",
  • "postal": "string",
  • "timezone": "string",
  • "useragent": "string",
  • "browser_name": "string",
  • "browser_version": "string",
  • "engine_name": "string",
  • "engine_version": "string",
  • "device_vendor": "string",
  • "device_model": "string",
  • "device_type": "string",
  • "os_name": "string",
  • "os_version": "string",
  • "cpu_arch": "string",
  • "encrypted_token": "string",
  • "revoked": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "user_id": 0,
  • "auth_provider": "string",
  • "ip": "string",
  • "hostname": "string",
  • "city": "string",
  • "region": "string",
  • "country": "string",
  • "loc": "string",
  • "org": "string",
  • "postal": "string",
  • "timezone": "string",
  • "useragent": "string",
  • "browser_name": "string",
  • "browser_version": "string",
  • "engine_name": "string",
  • "engine_version": "string",
  • "device_vendor": "string",
  • "device_model": "string",
  • "device_type": "string",
  • "os_name": "string",
  • "os_version": "string",
  • "cpu_arch": "string",
  • "encrypted_token": "string",
  • "revoked": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an authentication session by ID

Retrieves an authentication session based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Request samples 

const id = 0
app.service('auth_sessions').get(id)

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "user_id": 0,
  • "auth_provider": "string",
  • "ip": "string",
  • "hostname": "string",
  • "city": "string",
  • "region": "string",
  • "country": "string",
  • "loc": "string",
  • "org": "string",
  • "postal": "string",
  • "timezone": "string",
  • "useragent": "string",
  • "browser_name": "string",
  • "browser_version": "string",
  • "engine_name": "string",
  • "engine_version": "string",
  • "device_vendor": "string",
  • "device_model": "string",
  • "device_type": "string",
  • "os_name": "string",
  • "os_version": "string",
  • "cpu_arch": "string",
  • "encrypted_token": "string",
  • "revoked": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update an authentication session by ID

Updates an authentication session based on the provided ID and object.

Authorizations:
bearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
required

Authentication session object that needs to be updated

title
string
user_id
required
integer
auth_provider
string
ip
string
hostname
string
city
string
region
string
country
string
loc
string
org
string
postal
string
timezone
string
useragent
string
browser_name
string
browser_version
string
engine_name
string
engine_version
string
device_vendor
string
device_model
string
device_type
string
os_name
string
os_version
string
cpu_arch
string
encrypted_token
string
revoked
boolean

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "user_id": 0,
  • "auth_provider": "string",
  • "ip": "string",
  • "hostname": "string",
  • "city": "string",
  • "region": "string",
  • "country": "string",
  • "loc": "string",
  • "org": "string",
  • "postal": "string",
  • "timezone": "string",
  • "useragent": "string",
  • "browser_name": "string",
  • "browser_version": "string",
  • "engine_name": "string",
  • "engine_version": "string",
  • "device_vendor": "string",
  • "device_model": "string",
  • "device_type": "string",
  • "os_name": "string",
  • "os_version": "string",
  • "cpu_arch": "string",
  • "encrypted_token": "string",
  • "revoked": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "user_id": 0,
  • "auth_provider": "string",
  • "ip": "string",
  • "hostname": "string",
  • "city": "string",
  • "region": "string",
  • "country": "string",
  • "loc": "string",
  • "org": "string",
  • "postal": "string",
  • "timezone": "string",
  • "useragent": "string",
  • "browser_name": "string",
  • "browser_version": "string",
  • "engine_name": "string",
  • "engine_version": "string",
  • "device_vendor": "string",
  • "device_model": "string",
  • "device_type": "string",
  • "os_name": "string",
  • "os_version": "string",
  • "cpu_arch": "string",
  • "encrypted_token": "string",
  • "revoked": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Patch an authentication session by ID

Patches an authentication session based on the provided ID and object.

Authorizations:
bearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
required

Authentication session object that needs to be updated

title
string
user_id
required
integer
auth_provider
string
ip
string
hostname
string
city
string
region
string
country
string
loc
string
org
string
postal
string
timezone
string
useragent
string
browser_name
string
browser_version
string
engine_name
string
engine_version
string
device_vendor
string
device_model
string
device_type
string
os_name
string
os_version
string
cpu_arch
string
encrypted_token
string
revoked
boolean

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "user_id": 0,
  • "auth_provider": "string",
  • "ip": "string",
  • "hostname": "string",
  • "city": "string",
  • "region": "string",
  • "country": "string",
  • "loc": "string",
  • "org": "string",
  • "postal": "string",
  • "timezone": "string",
  • "useragent": "string",
  • "browser_name": "string",
  • "browser_version": "string",
  • "engine_name": "string",
  • "engine_version": "string",
  • "device_vendor": "string",
  • "device_model": "string",
  • "device_type": "string",
  • "os_name": "string",
  • "os_version": "string",
  • "cpu_arch": "string",
  • "encrypted_token": "string",
  • "revoked": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "user_id": 0,
  • "auth_provider": "string",
  • "ip": "string",
  • "hostname": "string",
  • "city": "string",
  • "region": "string",
  • "country": "string",
  • "loc": "string",
  • "org": "string",
  • "postal": "string",
  • "timezone": "string",
  • "useragent": "string",
  • "browser_name": "string",
  • "browser_version": "string",
  • "engine_name": "string",
  • "engine_version": "string",
  • "device_vendor": "string",
  • "device_model": "string",
  • "device_type": "string",
  • "os_name": "string",
  • "os_version": "string",
  • "cpu_arch": "string",
  • "encrypted_token": "string",
  • "revoked": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete an authentication session by ID

Deletes an authentication session based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "user_id": 0,
  • "auth_provider": "string",
  • "ip": "string",
  • "hostname": "string",
  • "city": "string",
  • "region": "string",
  • "country": "string",
  • "loc": "string",
  • "org": "string",
  • "postal": "string",
  • "timezone": "string",
  • "useragent": "string",
  • "browser_name": "string",
  • "browser_version": "string",
  • "engine_name": "string",
  • "engine_version": "string",
  • "device_vendor": "string",
  • "device_model": "string",
  • "device_type": "string",
  • "os_name": "string",
  • "os_version": "string",
  • "cpu_arch": "string",
  • "encrypted_token": "string",
  • "revoked": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Access Group Types

Retrieve a list of Group Types

Returns a list of Group Types.

Authorizations:
bearerAuth

Responses

Request samples 

app.service('access_group_types').find({ query: {} })

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Create a new group type

Creates a new group type based on the provided object.

Authorizations:
bearerAuth
Request Body schema: application/json
required

Group type object that needs to be added

name
string
slug
required
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "slug": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "slug": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve a group type by ID

Retrieves a group type based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Request samples 

const id = 0
app.service('access_group_types').get(id)

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "slug": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update a group type by ID

Updates a group type based on the provided ID and object.

Authorizations:
bearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
required

Group type object that needs to be updated

name
string
slug
required
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "slug": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "slug": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Patch a group type by ID

Patches a group type based on the provided ID and object.

Authorizations:
bearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
required

Group type object that needs to be updated

name
string
slug
required
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "slug": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "slug": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete a group type by ID

Deletes a group type based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "slug": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Access Groups

Retrieve a list of Groups

Returns a list of Groups.

Authorizations:
bearerAuth

Responses

Request samples 

app.service('access_groups').find({ query: {} })

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Create a new group

Creates a new group based on the provided object.

Authorizations:
bearerAuth
Request Body schema: application/json
required

Group object that needs to be added

type_id
required
integer
name
string
slug
string
description
string

Responses

Request samples

Content type
application/json
{
  • "type_id": 0,
  • "name": "string",
  • "slug": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type_id": 0,
  • "name": "string",
  • "slug": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve a group by ID

Retrieves a group based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Request samples 

const id = 0
app.service('access_groups').get(id)

Response samples

Content type
application/json
{
  • "id": 0,
  • "type_id": 0,
  • "name": "string",
  • "slug": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update a group by ID

Updates a group based on the provided ID and object.

Authorizations:
bearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
required

Group object that needs to be updated

type_id
required
integer
name
string
slug
string
description
string

Responses

Request samples

Content type
application/json
{
  • "type_id": 0,
  • "name": "string",
  • "slug": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type_id": 0,
  • "name": "string",
  • "slug": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Patch a group by ID

Patches a group based on the provided ID and object.

Authorizations:
bearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
required

Group object that needs to be updated

type_id
required
integer
name
string
slug
string
description
string

Responses

Request samples

Content type
application/json
{
  • "type_id": 0,
  • "name": "string",
  • "slug": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type_id": 0,
  • "name": "string",
  • "slug": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete a group by ID

Deletes a group based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "type_id": 0,
  • "name": "string",
  • "slug": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Access Scopes

Retrieve a list of Access Scopes

Returns a list of Access Scopes.

Authorizations:
bearerAuth

Responses

Request samples 

app.service('access_scopes').find({ query: {} })

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Create a new access scope

Creates a new access scope based on the provided object.

Authorizations:
bearerAuth
Request Body schema: application/json
required

Access scope object that needs to be added

name
string
slug
required
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "slug": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "slug": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an access scope by ID

Retrieves an access scope based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Request samples 

const id = 0
app.service('access_scopes').get(id)

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "slug": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update an access scope by ID

Updates an access scope based on the provided ID and object.

Authorizations:
bearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
required

Access scope object that needs to be updated

name
string
slug
required
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "slug": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "slug": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Patch an access scope by ID

Patches an access scope based on the provided ID and object.

Authorizations:
bearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
required

Access scope object that needs to be updated

name
string
slug
required
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "slug": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "slug": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete an access scope by ID

Deletes an access scope based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "slug": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Verify Email or Phone

Request verification token

Sends a verification token to email or phone for validation.

Request Body schema: application/json
required

Email or phone to receive verification token

One of
email
string

Responses

Request samples

Content type
application/json
{
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Verify token

Verifys an account by given email or phone.

path Parameters
id
required
string
Request Body schema: application/json
required

Email or phone to receiver

token
string

Responses

Request samples

Content type
application/json
{
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Recover Password

Request recovery token

Sends a recovery token to email for password reset.

Request Body schema: application/json
required

Email to receive recovery token

email
string

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Recover account

Recovers an account by given email.

path Parameters
email
required
string
Request Body schema: application/json
required

Email to receiver

token
string
password
string

Responses

Request samples

Content type
application/json
{
  • "token": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Roles

Retrieve a list of Roles

Returns a list of Roles.

Authorizations:
bearerAuth

Responses

Request samples 

app.service('roles').find({ query: {} })

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Create a new role

Creates a new role based on the provided object.

Authorizations:
bearerAuth
Request Body schema: application/json
required

Role object that needs to be added

name
string or null
slug
required
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "slug": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "slug": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve roles by ID

Retrieves roles based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Request samples 

const id = 0
app.service('roles').get(id)

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "slug": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update roles by ID

Updates roles based on the provided ID and object.

Authorizations:
bearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
required

Role object that needs to be updated

name
string or null
slug
required
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "slug": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "slug": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Patch roles by ID

Patches roles based on the provided ID and object.

Authorizations:
bearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
required

Role object that needs to be updated

name
string or null
slug
required
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "slug": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "slug": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete roles by ID

Deletes roles based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "slug": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Role Access Scopes

Retrieve a list of Role access scopes

Returns a list of Role access scopes.

Authorizations:
bearerAuth

Responses

Request samples 

app.service('role_access_scopes').find({ query: {} })

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Create a new role_access_scopes relation

Creates a new role_access_scopes relation based on the provided object.

Authorizations:
bearerAuth
Request Body schema: application/json
required

RoleAccessScope object that needs to be added

role_id
required
integer
access_scope_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "role_id": 0,
  • "access_scope_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "role_id": 0,
  • "access_scope_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve role_access_scopes by ID

Retrieves role_access_scopes based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Request samples 

const id = 0
app.service('role_access_scopes').get(id)

Response samples

Content type
application/json
{
  • "id": 0,
  • "role_id": 0,
  • "access_scope_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update role_access_scopes by ID

Updates role_access_scopes based on the provided ID and object.

Authorizations:
bearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
required

RoleAccessScope object that needs to be updated

role_id
required
integer
access_scope_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "role_id": 0,
  • "access_scope_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "role_id": 0,
  • "access_scope_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Patch role_access_scopes by ID

Patches role_access_scopes based on the provided ID and object.

Authorizations:
bearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
required

RoleAccessScope object that needs to be updated

role_id
required
integer
access_scope_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "role_id": 0,
  • "access_scope_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "role_id": 0,
  • "access_scope_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete role_access_scopes by ID

Deletes role_access_scopes based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "role_id": 0,
  • "access_scope_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Users

Retrieve a list of users

Returns a list of all users.

Authorizations:
bearerAuth

Responses

Request samples 

app.service('users').find({ query: {} })

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Create a new user

Creates a new user based on the provided user object.

Request Body schema: application/json
required

User object that needs to be added

username
string or null
email
required
string <email>
password
required
string
first_name
string or null
middle_name
string or null
last_name
string or null
picture
string or null
locale
string or null
phone
string or null

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "email": "user@example.com",
  • "password": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "picture": "string",
  • "locale": "string",
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "username": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "picture": "string",
  • "locale": "string",
  • "phone": "string",
  • "email_verified_at": "2019-08-24T14:15:22Z",
  • "phone_verified_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve a user by ID

Retrieves a user based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Request samples 

const id = 0
app.service('users').get(id)

Response samples

Content type
application/json
{
  • "id": 0,
  • "username": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "picture": "string",
  • "locale": "string",
  • "phone": "string",
  • "email_verified_at": "2019-08-24T14:15:22Z",
  • "phone_verified_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update a user by ID

Updates a user based on the provided ID and user object.

Authorizations:
bearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
required

User object that needs to be updated

username
string or null
email
required
string <email>
password
required
string
first_name
string or null
middle_name
string or null
last_name
string or null
picture
string or null
locale
string or null
phone
string or null

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "email": "user@example.com",
  • "password": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "picture": "string",
  • "locale": "string",
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "username": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "picture": "string",
  • "locale": "string",
  • "phone": "string",
  • "email_verified_at": "2019-08-24T14:15:22Z",
  • "phone_verified_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Patch a user by ID

Patches a user based on the provided ID and user object.

Authorizations:
bearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
required

User object that needs to be updated

username
string or null
email
required
string <email>
password
required
string
first_name
string or null
middle_name
string or null
last_name
string or null
picture
string or null
locale
string or null
phone
string or null

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "email": "user@example.com",
  • "password": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "picture": "string",
  • "locale": "string",
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "username": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "picture": "string",
  • "locale": "string",
  • "phone": "string",
  • "email_verified_at": "2019-08-24T14:15:22Z",
  • "phone_verified_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete a user by ID

Deletes a user based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "username": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "picture": "string",
  • "locale": "string",
  • "phone": "string",
  • "email_verified_at": "2019-08-24T14:15:22Z",
  • "phone_verified_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

User Authentication Providers

Retrieve a list of User Authentication Providers

Returns a list of User Authentication Providers.

Authorizations:
bearerAuth

Responses

Request samples 

app.service('user_oauth_providers').find({ query: {} })

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Create a new authentication provider

Creates a new authentication provider based on the provided object.

Authorizations:
bearerAuth
Request Body schema: application/json
required

Authentication Provider object that needs to be added

user_id
required
integer
slug
required
string
sub
required
string

Responses

Request samples

Content type
application/json
{
  • "user_id": 0,
  • "slug": "string",
  • "sub": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "slug": "string",
  • "sub": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve a user authentication provider by ID

Retrieves a user authentication provider based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Request samples 

const id = 0
app.service('user_oauth_providers').get(id)

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "slug": "string",
  • "sub": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update a user authentication provider by ID

Updates a user authentication provider based on the provided ID and object.

Authorizations:
bearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
required

User authentication provider object that needs to be updated

user_id
required
integer
slug
required
string
sub
required
string

Responses

Request samples

Content type
application/json
{
  • "user_id": 0,
  • "slug": "string",
  • "sub": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "slug": "string",
  • "sub": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Patch a user authentication provider by ID

Patches a user authentication provider based on the provided ID and object.

Authorizations:
bearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
required

User authentication provider object that needs to be updated

user_id
required
integer
slug
required
string
sub
required
string

Responses

Request samples

Content type
application/json
{
  • "user_id": 0,
  • "slug": "string",
  • "sub": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "slug": "string",
  • "sub": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete a user authentication provider by ID

Deletes a user authentication provider based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "slug": "string",
  • "sub": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

User Roles

Retrieve a list of User roles

Returns a list of User roles.

Authorizations:
bearerAuth

Responses

Request samples 

app.service('user_roles').find({ query: {} })

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Create a new user_roles relation

Creates a new user_roles relation based on the provided object.

Authorizations:
bearerAuth
Request Body schema: application/json
required

UserRole object that needs to be added

user_id
required
integer
role_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "user_id": 0,
  • "role_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "role_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve user_roles by ID

Retrieves user_roles based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Request samples 

const id = 0
app.service('user_roles').get(id)

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "role_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update user_roles by ID

Updates user_roles based on the provided ID and object.

Authorizations:
bearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
required

UserRole object that needs to be updated

user_id
required
integer
role_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "user_id": 0,
  • "role_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "role_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Patch user_roles by ID

Patches user_roles based on the provided ID and object.

Authorizations:
bearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
required

UserRole object that needs to be updated

user_id
required
integer
role_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "user_id": 0,
  • "role_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "role_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete user_roles by ID

Deletes user_roles based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "role_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

User Group Roles

Retrieve a list of User group roles

Returns a list of User group roles.

Authorizations:
bearerAuth

Responses

Request samples 

app.service('user_group_roles').find({ query: {} })

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Create a new user_group_roles relation

Creates a new user_group_roles relation based on the provided object.

Authorizations:
bearerAuth
Request Body schema: application/json
required

UserGroupRole object that needs to be added

user_id
required
integer
group_id
required
integer
role_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "user_id": 0,
  • "group_id": 0,
  • "role_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "group_id": 0,
  • "role_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve user_group_roles by ID

Retrieves user_group_roles based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Request samples 

const id = 0
app.service('user_group_roles').get(id)

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "group_id": 0,
  • "role_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update user_group_roles by ID

Updates user_group_roles based on the provided ID and object.

Authorizations:
bearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
required

UserGroupRole object that needs to be updated

user_id
required
integer
group_id
required
integer
role_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "user_id": 0,
  • "group_id": 0,
  • "role_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "group_id": 0,
  • "role_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Patch user_group_roles by ID

Patches user_group_roles based on the provided ID and object.

Authorizations:
bearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
required

UserGroupRole object that needs to be updated

user_id
required
integer
group_id
required
integer
role_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "user_id": 0,
  • "group_id": 0,
  • "role_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "group_id": 0,
  • "role_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete user_group_roles by ID

Deletes user_group_roles based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "group_id": 0,
  • "role_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Group group Roles

Retrieve a list of Group group roles

Returns a list of Group group roles.

Authorizations:
bearerAuth

Responses

Request samples 

app.service('group_group_roles').find({ query: {} })

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Create a new group_group_roles relation

Creates a new group_group_roles relation based on the provided object.

Authorizations:
bearerAuth
Request Body schema: application/json
required

GroupGroupRole object that needs to be added

parent_group_id
integer
child_group_id
integer
role_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "parent_group_id": 0,
  • "child_group_id": 0,
  • "role_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "parent_group_id": 0,
  • "child_group_id": 0,
  • "role_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve group_group_roles by ID

Retrieves group_group_roles based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Request samples 

const id = 0
app.service('group_group_roles').get(id)

Response samples

Content type
application/json
{
  • "id": 0,
  • "parent_group_id": 0,
  • "child_group_id": 0,
  • "role_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update group_group_roles by ID

Updates group_group_roles based on the provided ID and object.

Authorizations:
bearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
required

GroupGroupRole object that needs to be updated

parent_group_id
integer
child_group_id
integer
role_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "parent_group_id": 0,
  • "child_group_id": 0,
  • "role_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "parent_group_id": 0,
  • "child_group_id": 0,
  • "role_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Patch group_group_roles by ID

Patches group_group_roles based on the provided ID and object.

Authorizations:
bearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
required

GroupGroupRole object that needs to be updated

parent_group_id
integer
child_group_id
integer
role_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "parent_group_id": 0,
  • "child_group_id": 0,
  • "role_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "parent_group_id": 0,
  • "child_group_id": 0,
  • "role_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete group_group_roles by ID

Deletes group_group_roles based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "parent_group_id": 0,
  • "child_group_id": 0,
  • "role_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Events

Retrieve a list of Events

Returns a list of Events.

Authorizations:
bearerAuth

Responses

Request samples 

app.service('events').find({ query: {} })

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Create a new events relation

Creates a new events relation based on the provided object.

Authorizations:
bearerAuth
Request Body schema: application/json
required

Event object that needs to be added

source_table
string
event
required
string
Default: "custom"
Enum: "created" "updated" "patched" "removed" "custom"
custom_event
string
table_id
integer
user_id
integer
previous_user_id
integer

Responses

Request samples

Content type
application/json
{
  • "source_table": "string",
  • "event": "created",
  • "custom_event": "string",
  • "table_id": 0,
  • "user_id": 0,
  • "previous_user_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "source_table": "string",
  • "event": "created",
  • "custom_event": "string",
  • "table_id": 0,
  • "user_id": 0,
  • "previous_user_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve events by ID

Retrieves events based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Request samples 

const id = 0
app.service('events').get(id)

Response samples

Content type
application/json
{
  • "id": 0,
  • "source_table": "string",
  • "event": "created",
  • "custom_event": "string",
  • "table_id": 0,
  • "user_id": 0,
  • "previous_user_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update events by ID

Updates events based on the provided ID and object.

Authorizations:
bearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
required

Event object that needs to be updated

source_table
string
event
required
string
Default: "custom"
Enum: "created" "updated" "patched" "removed" "custom"
custom_event
string
table_id
integer
user_id
integer
previous_user_id
integer

Responses

Request samples

Content type
application/json
{
  • "source_table": "string",
  • "event": "created",
  • "custom_event": "string",
  • "table_id": 0,
  • "user_id": 0,
  • "previous_user_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "source_table": "string",
  • "event": "created",
  • "custom_event": "string",
  • "table_id": 0,
  • "user_id": 0,
  • "previous_user_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Patch events by ID

Patches events based on the provided ID and object.

Authorizations:
bearerAuth
path Parameters
id
required
integer
Request Body schema: application/json
required

Event object that needs to be updated

source_table
string
event
required
string
Default: "custom"
Enum: "created" "updated" "patched" "removed" "custom"
custom_event
string
table_id
integer
user_id
integer
previous_user_id
integer

Responses

Request samples

Content type
application/json
{
  • "source_table": "string",
  • "event": "created",
  • "custom_event": "string",
  • "table_id": 0,
  • "user_id": 0,
  • "previous_user_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "source_table": "string",
  • "event": "created",
  • "custom_event": "string",
  • "table_id": 0,
  • "user_id": 0,
  • "previous_user_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete events by ID

Deletes events based on the provided ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "source_table": "string",
  • "event": "created",
  • "custom_event": "string",
  • "table_id": 0,
  • "user_id": 0,
  • "previous_user_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}