The Aircampi Auth API is served over HTTPS. All URLs referenced in the documentation have the following Base URL. It can be your custom domain or {project_id}.aircampi.com (full URL).
There are three ways to authenticate with this API:
- with an OAuth2 Access Token in the
Authorization
request header field (which uses theBearer
authentication scheme to transmit the Access Token) - with your Client ID and Client Secret credentials
- only with your Client ID
Each endpoint supports only one option.
When an error occurs, you will receive an error object. Most of these error objects contain an error code and an error description so that your applications can more efficiently identify the problem.
The Auth API is subject to rate limiting. The limits differ per endpoint.
If you exceed the provided rate limit for a given endpoint, you will receive the 429 Too Many Requests
response with the following message: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
The authentication and authorization APIs enables you to manage all aspects of user identity when you use Aircampi Auth. It offers endpoints so your users can log in, sign up, log out, access APIs, and more.
The Management API allows you to manage your account programmatically, so you can automate configuration of your environment. Most of the tasks you can perform in the Aircampi Auth Management can also be performed programmatically by using this API.
To begin an OAuth 2.0 Authorization flow, your application should first send the user to the authorization URL.
Get an Access Token in order to call an API. Optionally, you can also retrieve an ID Token and a Refresh Token. Refresh your Access Token using a Refresh Token you got during authorization.
Get Token
Get an Access Token using different type of grant.
Grant Types:
- Password
- Refresh Token
- Authorization Code
- Authorization Code and Verifier
- Client Credentials
- Device Code
- One-Time Password (OTP)
Authorizations:
Request Body schema: application/json
Token
grant_type required | string (grant_type) Grant Type for Token |
username required | string Username |
password required | string User Password |
client_id required | string <uuid> (client_id) Client Id. System generated uuid |
client_secret | string (client_secret) Client Secret |
audience | string The unique identifier of the target API you want to access. |
scope | string String value of the different scopes the application is asking for. Multiple scopes are separated with whitespace. |
Responses
Request samples
- Payload
{- "grant_type": "password",
- "username": "string",
- "password": "string",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "client_secret": "string",
- "audience": "string",
- "scope": "string"
}
Response samples
- 200
{- "access_token": "eyJz93a...k4laUWw",
- "refresh_token": "GEbRxBN...edjnXbL",
- "id_token": "eyJ0XAi...4faeEoQ",
- "token_type": "Bearer",
- "expires_in": 86400
}
Revoke Token
Use this endpoint to invalidate a Refresh Token if it has been compromised.
Authorizations:
Request Body schema: application/json
Revoke Token
token required | string Refresh Token to revoke |
client_id required | string <uuid> (client_id) Client Id. System generated uuid |
client_secret | string (client_secret) Client Secret |
Responses
Request samples
- Payload
{- "token": "dkafjld...dfkajlds",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "client_secret": "string"
}
Get User Info
Given the Access Token obtained during login, this endpoint returns a user's info.
This endpoint will work only if openid
was granted as a scope for the Access Token.
The user information included in the response depends on the scopes requested.
For example, a scope of just openid
may return less information than a a scope of openid
profile
email
.
Authorizations:
header Parameters
Authorization required | string Default: Bearer {{access_token}} The Access Token obtained during login. |
Responses
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_nickname": "Bayaraa",
- "user_fullName": "Bayaraa Basan",
- "user_email_verified": true,
- "user_phone": "+1-202-555-0192",
- "user_phone_verified": true,
- "user_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "is_blocked": false,
- "is_invited": true,
- "invited_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "last_sign_in_at": null,
- "logins": 0,
- "identities": 0,
- "permissions": 0,
- "roles": 0,
- "tokens": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "identities": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "identity_provider": "aircampi",
- "user_identifier": "string",
- "identity_data": {
- "profile_picture": "string",
- "username": "string",
- "user_fullname": "string",
- "email_verified": false,
- "phone": "+1-202-555-0192",
- "phone_verified": false
}, - "refresh_token": "string",
- "access_token": "string",
- "access_token_secret": "string",
- "last_sign_in_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "tenants": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
There are three options for One-Time Password: Send a verification code using email. Send a link using email. Send a verification code using SMS.
Get Code or Link
Get Code or Link
Request Body schema: application/json
Get Code or Link
client_id required | string <uuid> (client_id) Client Id. System generated uuid |
client_secret required | string (client_secret) Client Secret |
username required | string Username. It must be email or phone. |
object Use this to append or override the link parameters |
Responses
Request samples
- Payload
{- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "client_secret": "string",
- "username": "string",
- "options": {
- "send_type": "link",
- "redirect_url": "string",
- "response_type": "authorization_code",
- "scope": "string"
}
}
To begin the Device Authorization Flow, your application should first request a device code.
Get Device Code
This is the flow that input-constrained devices use to access an API. Use this endpoint to get a device code.
Authorizations:
Request Body schema: application/json
Get Device Code
client_id required | string <uuid> (client_id) Client Id. System generated uuid |
audience | string The unique identifier of the target API you want to access. |
scope | string The scopes for which you want to request authorization. These must be separated by a space. |
Responses
Request samples
- Payload
{- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "audience": "string",
- "scope": "string"
}
Response samples
- 200
{- "device_code": "eyJz93a...k4laUWw",
- "user_code": "GEbRxBN...edjnXbL",
- "verification_uri": "eyJ0XAi...4faeEoQ",
- "verification_uri_complete": "Bearer",
- "expires_in": 86400,
- "interval": 86400
}
Get instances
Retrieve filtered list of instances. It works when multi-instance mode is enabled
Authorizations:
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="instance_id,instance_metadata" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
q | string This query parameter defines the where clause. Example: ?q="instance_id>1" |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort="instance_name asc,instance_description desc" |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instance_name": "string",
- "instance_description": "string",
- "instance_metadata": {
- "identity_providers": [
- {
- "identity_provider": "aircampi",
- "enabled": true
}
], - "supported_locales": [
- "mn"
], - "password_validators": [
- {
- "order": 1,
- "validator": "default",
- "description": "Default Password Validator",
- "rules": "(?=^.{8,}$)(?=.*\\d)(?=.*[!@#$%^&*]+)(?![.\\n])(?=.*[A-Z])(?=.*[a-z]).*$"
}
]
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
- "clients": 0,
- "tenants": 0,
- "resources": 0,
- "users": 0,
- "roles": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "admins": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_nickname": "Bayaraa",
- "user_fullName": "Bayaraa Basan",
- "user_email_verified": true,
- "user_phone": "+1-202-555-0192",
- "user_phone_verified": true,
- "user_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "is_blocked": false,
- "is_invited": true,
- "invited_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "last_sign_in_at": null,
- "logins": 0,
- "identities": 0,
- "permissions": 0,
- "roles": 0,
- "tokens": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "identities": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "identity_provider": "aircampi",
- "user_identifier": "string",
- "identity_data": {
- "profile_picture": "string",
- "username": "string",
- "user_fullname": "string",
- "email_verified": false,
- "phone": "+1-202-555-0192",
- "phone_verified": false
}, - "refresh_token": "string",
- "access_token": "string",
- "access_token_secret": "string",
- "last_sign_in_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "tenants": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
]
}
Create an instance
Create an instance
Authorizations:
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="instance_id,instance_name" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Create an Instance
instance_name | string non-empty Name of Instance |
instance_description | string Description of Instance |
Responses
Request samples
- Payload
{- "instance_name": "Additional Instance Name",
- "instance_description": "Additional Instance Description"
}
Response samples
- 201
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instance_name": "string",
- "instance_description": "string",
- "instance_metadata": {
- "identity_providers": [
- {
- "identity_provider": "aircampi",
- "enabled": true
}
], - "supported_locales": [
- "mn"
], - "password_validators": [
- {
- "order": 1,
- "validator": "default",
- "description": "Default Password Validator",
- "rules": "(?=^.{8,}$)(?=.*\\d)(?=.*[!@#$%^&*]+)(?![.\\n])(?=.*[A-Z])(?=.*[a-z]).*$"
}
]
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
- "clients": 0,
- "tenants": 0,
- "resources": 0,
- "users": 0,
- "roles": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "admins": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_nickname": "Bayaraa",
- "user_fullName": "Bayaraa Basan",
- "user_email_verified": true,
- "user_phone": "+1-202-555-0192",
- "user_phone_verified": true,
- "user_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "is_blocked": false,
- "is_invited": true,
- "invited_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "last_sign_in_at": null,
- "logins": 0,
- "identities": 0,
- "permissions": 0,
- "roles": 0,
- "tokens": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "identities": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "identity_provider": "aircampi",
- "user_identifier": "string",
- "identity_data": {
- "profile_picture": "string",
- "username": "string",
- "user_fullname": "string",
- "email_verified": false,
- "phone": "+1-202-555-0192",
- "phone_verified": false
}, - "refresh_token": "string",
- "access_token": "string",
- "access_token_secret": "string",
- "last_sign_in_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "tenants": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Get an instance
Get an instance
Authorizations:
path Parameters
instance_id required | string <uuid> (instance_id) Instance Id. System generated UUID |
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="instance_id,instance_name" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instance_name": "string",
- "instance_description": "string",
- "instance_metadata": {
- "identity_providers": [
- {
- "identity_provider": "aircampi",
- "enabled": true
}
], - "supported_locales": [
- "mn"
], - "password_validators": [
- {
- "order": 1,
- "validator": "default",
- "description": "Default Password Validator",
- "rules": "(?=^.{8,}$)(?=.*\\d)(?=.*[!@#$%^&*]+)(?![.\\n])(?=.*[A-Z])(?=.*[a-z]).*$"
}
]
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
- "clients": 0,
- "tenants": 0,
- "resources": 0,
- "users": 0,
- "roles": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "admins": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_nickname": "Bayaraa",
- "user_fullName": "Bayaraa Basan",
- "user_email_verified": true,
- "user_phone": "+1-202-555-0192",
- "user_phone_verified": true,
- "user_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "is_blocked": false,
- "is_invited": true,
- "invited_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "last_sign_in_at": null,
- "logins": 0,
- "identities": 0,
- "permissions": 0,
- "roles": 0,
- "tokens": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "identities": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "identity_provider": "aircampi",
- "user_identifier": "string",
- "identity_data": {
- "profile_picture": "string",
- "username": "string",
- "user_fullname": "string",
- "email_verified": false,
- "phone": "+1-202-555-0192",
- "phone_verified": false
}, - "refresh_token": "string",
- "access_token": "string",
- "access_token_secret": "string",
- "last_sign_in_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "tenants": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Modify an instance
Modify an instance
Authorizations:
path Parameters
instance_id required | string <uuid> (instance_id) Instance Id. System generated UUID |
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="instance_id,instance_name" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Update an Instance
instance_name | string Name of Instance |
instance_description | string Description of Instance |
object (instance_metadata) instance's metadata structure | |
Array of objects (app_metadata) application metadata structure for customize your needs. |
Responses
Request samples
- Payload
{- "instance_name": "Changed Instance Name",
- "instance_description": "Changed Instance Description",
- "instance_metadata": {
- "identity_providers": [
- {
- "identity_provider": "aircampi",
- "enabled": true
}
], - "supported_locales": [
- "mn"
], - "password_validators": [
- {
- "order": 1,
- "validator": "default",
- "description": "Default Password Validator",
- "rules": "(?=^.{8,}$)(?=.*\\d)(?=.*[!@#$%^&*]+)(?![.\\n])(?=.*[A-Z])(?=.*[a-z]).*$"
}
]
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
]
}
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instance_name": "string",
- "instance_description": "string",
- "instance_metadata": {
- "identity_providers": [
- {
- "identity_provider": "aircampi",
- "enabled": true
}
], - "supported_locales": [
- "mn"
], - "password_validators": [
- {
- "order": 1,
- "validator": "default",
- "description": "Default Password Validator",
- "rules": "(?=^.{8,}$)(?=.*\\d)(?=.*[!@#$%^&*]+)(?![.\\n])(?=.*[A-Z])(?=.*[a-z]).*$"
}
]
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
- "clients": 0,
- "tenants": 0,
- "resources": 0,
- "users": 0,
- "roles": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "admins": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_nickname": "Bayaraa",
- "user_fullName": "Bayaraa Basan",
- "user_email_verified": true,
- "user_phone": "+1-202-555-0192",
- "user_phone_verified": true,
- "user_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "is_blocked": false,
- "is_invited": true,
- "invited_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "last_sign_in_at": null,
- "logins": 0,
- "identities": 0,
- "permissions": 0,
- "roles": 0,
- "tokens": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "identities": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "identity_provider": "aircampi",
- "user_identifier": "string",
- "identity_data": {
- "profile_picture": "string",
- "username": "string",
- "user_fullname": "string",
- "email_verified": false,
- "phone": "+1-202-555-0192",
- "phone_verified": false
}, - "refresh_token": "string",
- "access_token": "string",
- "access_token_secret": "string",
- "last_sign_in_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "tenants": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Get instance's admins
Retrieve admin users associated with an instance
Authorizations:
path Parameters
instance_id required | string <uuid> (instance_id) Instance Id. System generated UUID |
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="instance_id,instance_metadata" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
q | string This query parameter defines the where clause. Example: ?q="instance_id>1" |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort="instance_name asc,instance_description desc" |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_nickname": "Bayaraa",
- "user_fullName": "Bayaraa Basan",
- "user_email_verified": true,
- "user_phone": "+1-202-555-0192",
- "user_phone_verified": true,
- "user_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "is_blocked": false,
- "is_invited": true,
- "invited_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "last_sign_in_at": null,
- "logins": 0,
- "identities": 0,
- "permissions": 0,
- "roles": 0,
- "tokens": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "identities": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "identity_provider": "aircampi",
- "user_identifier": "string",
- "identity_data": {
- "profile_picture": "string",
- "username": "string",
- "user_fullname": "string",
- "email_verified": false,
- "phone": "+1-202-555-0192",
- "phone_verified": false
}, - "refresh_token": "string",
- "access_token": "string",
- "access_token_secret": "string",
- "last_sign_in_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "tenants": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Add instance's admins
Add instance's admins
Authorizations:
path Parameters
instance_id required | string <uuid> (instance_id) Instance Id. System generated UUID |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
List of Users
users | Array of strings <uuid> (user_id) |
Responses
Request samples
- Payload
{- "users": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Remove instance's admins
Remove instance's admins
Authorizations:
path Parameters
instance_id required | string <uuid> (instance_id) instance UUID |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
List of Users
users | Array of strings <uuid> (user_id) |
Responses
Request samples
- Payload
{- "users": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Get clients
Retrieve filtered list of clients.
Authorizations:
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="client_id,client_metadata" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
q | string This query parameter defines the where clause. Example: ?q="client_id>1" |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort="instance_name asc,instance_description desc" |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "client_name": "Web App",
- "client_secret": "dksafjl3241894019lkj3241",
- "client_secret_expires_at": "2019-08-24T14:15:22Z",
- "client_description": "Web Client App",
- "client_metadata": {
- "app_type": "mobile",
- "grant_types": [
- "password"
], - "refresh_token": {
- "expiration_enabled": false,
- "expiration_lifetime": 2592000
}, - "mobile": {
- "ios": {
- "team_id": "9JA890OLNO",
- "app_id": "com.aircampi.bundle"
}, - "android": {
- "package_name": "com.example",
- "hash_keys": "D8: A0:83 : D9 : C1: B2:..."
}
}
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "is_first_party": true,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "permissions": 0,
- "resources": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Create a client
Create a client
Authorizations:
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="client_id,client_name" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Create an Client
client_name | string non-empty Name of Client |
client_description | string Description of Client |
Responses
Request samples
- Payload
{- "client_name": "Additional Client Name",
- "client_description": "Additional Client Description"
}
Response samples
- 201
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "client_name": "Web App",
- "client_secret": "dksafjl3241894019lkj3241",
- "client_secret_expires_at": "2019-08-24T14:15:22Z",
- "client_description": "Web Client App",
- "client_metadata": {
- "app_type": "mobile",
- "grant_types": [
- "password"
], - "refresh_token": {
- "expiration_enabled": false,
- "expiration_lifetime": 2592000
}, - "mobile": {
- "ios": {
- "team_id": "9JA890OLNO",
- "app_id": "com.aircampi.bundle"
}, - "android": {
- "package_name": "com.example",
- "hash_keys": "D8: A0:83 : D9 : C1: B2:..."
}
}
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "is_first_party": true,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "permissions": 0,
- "resources": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Get a client
Retrieve client details.
Authorizations:
path Parameters
client_id required | string <uuid> (client_id) Client Id. System generated UUID |
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="client_id,client_name" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "client_name": "Web App",
- "client_secret": "dksafjl3241894019lkj3241",
- "client_secret_expires_at": "2019-08-24T14:15:22Z",
- "client_description": "Web Client App",
- "client_metadata": {
- "app_type": "mobile",
- "grant_types": [
- "password"
], - "refresh_token": {
- "expiration_enabled": false,
- "expiration_lifetime": 2592000
}, - "mobile": {
- "ios": {
- "team_id": "9JA890OLNO",
- "app_id": "com.aircampi.bundle"
}, - "android": {
- "package_name": "com.example",
- "hash_keys": "D8: A0:83 : D9 : C1: B2:..."
}
}
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "is_first_party": true,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "permissions": 0,
- "resources": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Modify a client
Modify a client
Authorizations:
path Parameters
client_id required | string <uuid> (client_id) Client Id. System generated UUID |
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="client_id,client_name" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Update an Client
client_name | string Name of Client |
client_description | string Description of Client |
object (client_metadata) Client's metadata structure | |
Array of objects (app_metadata) application metadata structure for customize your needs. |
Responses
Request samples
- Payload
{- "client_name": "Changed Client Name",
- "client_description": "Changed Client Description",
- "client_metadata": {
- "app_type": "mobile",
- "grant_types": [
- "password"
], - "refresh_token": {
- "expiration_enabled": false,
- "expiration_lifetime": 2592000
}, - "mobile": {
- "ios": {
- "team_id": "9JA890OLNO",
- "app_id": "com.aircampi.bundle"
}, - "android": {
- "package_name": "com.example",
- "hash_keys": "D8: A0:83 : D9 : C1: B2:..."
}
}
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
]
}
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "client_name": "Web App",
- "client_secret": "dksafjl3241894019lkj3241",
- "client_secret_expires_at": "2019-08-24T14:15:22Z",
- "client_description": "Web Client App",
- "client_metadata": {
- "app_type": "mobile",
- "grant_types": [
- "password"
], - "refresh_token": {
- "expiration_enabled": false,
- "expiration_lifetime": 2592000
}, - "mobile": {
- "ios": {
- "team_id": "9JA890OLNO",
- "app_id": "com.aircampi.bundle"
}, - "android": {
- "package_name": "com.example",
- "hash_keys": "D8: A0:83 : D9 : C1: B2:..."
}
}
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "is_first_party": true,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "permissions": 0,
- "resources": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Delete a client
Delete a client. Default Client cannot be deleted.
Authorizations:
path Parameters
client_id required | string <uuid> (client_id) The Client Id. System generated UUID that needs to be deleted |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Change a client secret
Change a client secret
Authorizations:
path Parameters
client_id required | string <uuid> (client_id) Client Id. System generated UUID |
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="client_id,client_name" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "client_name": "Web App",
- "client_secret": "dksafjl3241894019lkj3241",
- "client_secret_expires_at": "2019-08-24T14:15:22Z",
- "client_description": "Web Client App",
- "client_metadata": {
- "app_type": "mobile",
- "grant_types": [
- "password"
], - "refresh_token": {
- "expiration_enabled": false,
- "expiration_lifetime": 2592000
}, - "mobile": {
- "ios": {
- "team_id": "9JA890OLNO",
- "app_id": "com.aircampi.bundle"
}, - "android": {
- "package_name": "com.example",
- "hash_keys": "D8: A0:83 : D9 : C1: B2:..."
}
}
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "is_first_party": true,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "permissions": 0,
- "resources": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Get client's permissions
Retrieve permissions associated with a client
Authorizations:
path Parameters
client_id required | string <uuid> (client_id) Client Id. System generated UUID |
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="id,client_id,resource_id" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
q | string This query parameter defines the where clause. Example: ?q="grant_type=implicit" |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort="instance_name asc,instance_description desc" |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Grant permissions to client
Grant permissions to client
Authorizations:
path Parameters
client_id required | string <uuid> (client_id) Client Id. System generated UUID |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
List of Permissions
Array of objects | |||
Array
|
Responses
Request samples
- Payload
{- "permissions": [
- {
- "scopes": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
]
}
Revoke permissions from client
Revoke permissions from client.
Authorizations:
path Parameters
client_id required | string <uuid> (client_id) Client Id. System generated UUID |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
List of Permissions
Array of objects | |||
Array
|
Responses
Request samples
- Payload
{- "permissions": [
- {
- "scopes": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
]
}
Get resources
Retrieve filtered list of resource.
Authorizations:
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="resource_id,resource_metadata" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
q | string This query parameter defines the where clause. Example: ?q="client_id>1" |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort="instance_name asc,instance_description desc" |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_type": "API",
- "resource_name": "string",
- "resource_description": "string",
- "resource_metadata": {
- "api": {
- "identifier_url": "string",
- "expiration_lifetime": 2592000,
- "is_system": false
}, - "token": {
- "expiration_lifetime": 86400,
- "signing_algorithm": "HS256",
- "signing_secret": "string"
}, - "skip_consent_for_first_party": false
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_date": "2019-08-24T14:15:22Z",
- "updated_date": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scopes": 0,
- "clients": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "scopes": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_name": "string",
- "scope_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "clients": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "authorized": true,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Create a resource
Create a resource
Authorizations:
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="resource_id,resource_name" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Create a resource
resource_type | string (resource_type) Value: "API" Type of Resource |
resource_name | string non-empty Name of Resource |
resource_description | string Description of Resource |
object (resource_metadata) Resource's metadata |
Responses
Request samples
- Payload
{- "resource_type": "API",
- "resource_name": "Additional Resource Name",
- "resource_description": "Additional Resource Description",
- "resource_metadata": {
- "api": {
- "identifier_url": "string",
- "expiration_lifetime": 2592000,
- "is_system": false
}, - "token": {
- "expiration_lifetime": 86400,
- "signing_algorithm": "HS256",
- "signing_secret": "string"
}, - "skip_consent_for_first_party": false
}
}
Response samples
- 201
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_type": "API",
- "resource_name": "string",
- "resource_description": "string",
- "resource_metadata": {
- "api": {
- "identifier_url": "string",
- "expiration_lifetime": 2592000,
- "is_system": false
}, - "token": {
- "expiration_lifetime": 86400,
- "signing_algorithm": "HS256",
- "signing_secret": "string"
}, - "skip_consent_for_first_party": false
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_date": "2019-08-24T14:15:22Z",
- "updated_date": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scopes": 0,
- "clients": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "scopes": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_name": "string",
- "scope_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "clients": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "authorized": true,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Get a resource
Retrieve resource details.
Authorizations:
path Parameters
resource_id required | string <uuid> (resource_id) Resource Id. System generated UUID |
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="resource_id,resource_name" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_type": "API",
- "resource_name": "string",
- "resource_description": "string",
- "resource_metadata": {
- "api": {
- "identifier_url": "string",
- "expiration_lifetime": 2592000,
- "is_system": false
}, - "token": {
- "expiration_lifetime": 86400,
- "signing_algorithm": "HS256",
- "signing_secret": "string"
}, - "skip_consent_for_first_party": false
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_date": "2019-08-24T14:15:22Z",
- "updated_date": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scopes": 0,
- "clients": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "scopes": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_name": "string",
- "scope_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "clients": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "authorized": true,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Modify a resource
Modify a resource
Authorizations:
path Parameters
resource_id required | string <uuid> (resource_id) Resource Id. System generated UUID |
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="resource_id,resource_name" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Update a resource
resource_name | string Name of Resource |
resource_description | string Description of Resource |
object (resource_metadata) Resource's metadata | |
Array of objects (app_metadata) application metadata structure for customize your needs. |
Responses
Request samples
- Payload
{- "resource_name": "Changed Resource Name",
- "resource_description": "Changed Resource Description",
- "resource_metadata": {
- "api": {
- "identifier_url": "string",
- "expiration_lifetime": 2592000,
- "is_system": false
}, - "token": {
- "expiration_lifetime": 86400,
- "signing_algorithm": "HS256",
- "signing_secret": "string"
}, - "skip_consent_for_first_party": false
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
]
}
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_type": "API",
- "resource_name": "string",
- "resource_description": "string",
- "resource_metadata": {
- "api": {
- "identifier_url": "string",
- "expiration_lifetime": 2592000,
- "is_system": false
}, - "token": {
- "expiration_lifetime": 86400,
- "signing_algorithm": "HS256",
- "signing_secret": "string"
}, - "skip_consent_for_first_party": false
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_date": "2019-08-24T14:15:22Z",
- "updated_date": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scopes": 0,
- "clients": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "scopes": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_name": "string",
- "scope_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "clients": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "authorized": true,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Get resource scopes
Retrieve scopes associated with a resouce
Authorizations:
path Parameters
resource_id required | string <uuid> (resource_id) Resource Id. System generated UUID |
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="resource_id,resource_metadata" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
q | string This query parameter defines the where clause. Example: ?q="client_id>1" |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort="instance_name asc,instance_description desc" |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_name": "string",
- "scope_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
Create a resource scope
Create a resource scope
Authorizations:
path Parameters
resource_id required | string <uuid> (resource_id) Resource Id. System generated UUID |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Create a resource scope
scope_name | string non-empty Name of Scope |
scope_description | string Description of Scope |
Responses
Request samples
- Payload
{- "scope_name": "Additional Scope Name",
- "scope_description": "Additional Scope Description"
}
Get a resource scope
Retrieve resource scope details.
Authorizations:
path Parameters
resource_id required | string <uuid> (resource_id) Resource Id. System generated UUID |
scope_id required | string <uuid> (scope_id) Scope Id |
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="id,scope_name,scope_description" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_name": "string",
- "scope_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
Modify a resource scope
Modify a resource scope
Authorizations:
path Parameters
resource_id required | string <uuid> (resource_id) Resource Id. System generated UUID |
scope_id required | string <uuid> (scope_id) Scope Id |
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="id,scope_name,scope_description" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Update a resource scope
scope_name | string Name of Scope |
scope_description | string Description of Scope |
Responses
Request samples
- Payload
{- "scope_name": "Change Scope Name",
- "scope_description": "Change Scope Description"
}
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_name": "string",
- "scope_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
Delete a resource scope
Delete a resource scope
Authorizations:
path Parameters
resource_id required | string <uuid> (resource_id) Resource Id. System generated UUID |
scope_id required | string <uuid> (scope_id) Scope Id |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Get resource clients
Retrieve clients associated with a resouce
Authorizations:
path Parameters
resource_id required | string <uuid> (resource_id) Resource Id. System generated UUID |
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="client_id,authorized" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
q | string This query parameter defines the where clause. Example: ?q="client_id>1" |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort="instance_name asc,instance_description desc" |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "authorized": true,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Authorize clients to resource
Authorize clients to resource.
Authorizations:
path Parameters
resource_id required | string <uuid> (resource_id) Resource Id. System generated UUID |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
List of Clients
clients | Array of strings <uuid> (client_id) |
Responses
Request samples
- Payload
{- "clients": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Unauthorize clients from resource.
Unauthorize clients from resource
Authorizations:
path Parameters
resource_id required | string <uuid> (resource_id) Resource Id. System generated UUID. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
List of Clients
clients | Array of strings <uuid> (client_id) |
Responses
Request samples
- Payload
{- "clients": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Get roles
Retrieve filtered list of roles.
Authorizations:
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="role_id,role_metadata" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
q | string This query parameter defines the where clause. Example: ?q="role_id>1" |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort="instance_name asc,instance_description desc" |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_name": "string",
- "role_description": "string",
- "role_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "permissions": 0,
- "users": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "members": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Create a role
Create a role
Authorizations:
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="role_id,role_name" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Create an Role
role_name | string non-empty Name of Role |
role_description | string Description of Role |
Responses
Request samples
- Payload
{- "role_name": "Additional Role Name",
- "role_description": "Additional Role Description"
}
Response samples
- 201
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_name": "string",
- "role_description": "string",
- "role_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "permissions": 0,
- "users": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "members": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Get a role
Retrieve role details.
Authorizations:
path Parameters
role_id required | string <uuid> (role_id) Role Id. System generated UUID |
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="role_id,role_name" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_name": "string",
- "role_description": "string",
- "role_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "permissions": 0,
- "users": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "members": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Modify a role
Modify a role
Authorizations:
path Parameters
role_id required | string <uuid> (role_id) Role Id. System generated UUID |
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="role_id,role_name" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Update an Role
role_name | string Name of Role |
role_description | string Description of Role |
role_metadata | object (role_metadata) Role's metadata |
Array of objects (app_metadata) application metadata structure for customize your needs. |
Responses
Request samples
- Payload
{- "role_name": "Changed Role Name",
- "role_description": "Changed Role Description",
- "role_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
]
}
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_name": "string",
- "role_description": "string",
- "role_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "permissions": 0,
- "users": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "members": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Get role members
Get role members
Authorizations:
path Parameters
role_id required | string <uuid> (role_id) Role Id. System generated UUID |
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="role_id,user_id" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
q | string This query parameter defines the where clause. Example: ?q="role_id>1" |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort="instance_name asc,instance_description desc" |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Assign users to a role
Assign users to a role
Authorizations:
path Parameters
role_id required | string <uuid> (role_id) Role Id. System generated UUID |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
List of Users
users | Array of strings <uuid> (user_id) |
Responses
Request samples
- Payload
{- "users": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Remove users from a role
Remove users from a role
Authorizations:
path Parameters
role_id required | string <uuid> (role_id) Role Id. System generated UUID. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
List of Users
users | Array of strings <uuid> (user_id) |
Responses
Request samples
- Payload
{- "users": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Get role permissions
Get role permissions
Authorizations:
path Parameters
role_id required | string <uuid> (role_id) Role Id. System generated UUID |
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="role_id,resource_id" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
q | string This query parameter defines the where clause. Example: ?q="role_id>1" |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort="instance_name asc,instance_description desc" |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Grant permissions to a role
Grant permissions to a role
Authorizations:
path Parameters
role_id required | string <uuid> (role_id) Role Id. System generated UUID |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
List of Permissions
Array of objects | |||
Array
|
Responses
Request samples
- Payload
{- "permissions": [
- {
- "scopes": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
]
}
Revoke permissions from a role
Revoke permissions from a role
Authorizations:
path Parameters
role_id required | string <uuid> (role_id) Role Id. System generated UUID. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
List of Permissions
Array of objects | |||
Array
|
Responses
Request samples
- Payload
{- "permissions": [
- {
- "scopes": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
]
}
Get users
Retrieve filtered list of users.
Authorizations:
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=user_id,user_nickname |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=aggregates |
q | string This query parameter defines the where clause. Example: ?q=UserId>=10 and <= 30;Loc!=NY |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=field1 asc,field2 desc |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_nickname": "Bayaraa",
- "user_fullName": "Bayaraa Basan",
- "user_email_verified": true,
- "user_phone": "+1-202-555-0192",
- "user_phone_verified": true,
- "user_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "is_blocked": false,
- "is_invited": true,
- "invited_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "last_sign_in_at": null,
- "logins": 0,
- "identities": 0,
- "permissions": 0,
- "roles": 0,
- "tokens": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "identities": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "identity_provider": "aircampi",
- "user_identifier": "string",
- "identity_data": {
- "profile_picture": "string",
- "username": "string",
- "user_fullname": "string",
- "email_verified": false,
- "phone": "+1-202-555-0192",
- "phone_verified": false
}, - "refresh_token": "string",
- "access_token": "string",
- "access_token_secret": "string",
- "last_sign_in_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "tenants": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Create an user
Create an user
Authorizations:
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="instance_id,instance_name" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Create an user
user_name | string non-empty Name of User |
user_description | string Description of User |
Responses
Request samples
- Payload
{- "user_name": "Additional User Name",
- "user_description": "Additional User Description"
}
Response samples
- 201
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_nickname": "Bayaraa",
- "user_fullName": "Bayaraa Basan",
- "user_email_verified": true,
- "user_phone": "+1-202-555-0192",
- "user_phone_verified": true,
- "user_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "is_blocked": false,
- "is_invited": true,
- "invited_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "last_sign_in_at": null,
- "logins": 0,
- "identities": 0,
- "permissions": 0,
- "roles": 0,
- "tokens": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "identities": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "identity_provider": "aircampi",
- "user_identifier": "string",
- "identity_data": {
- "profile_picture": "string",
- "username": "string",
- "user_fullname": "string",
- "email_verified": false,
- "phone": "+1-202-555-0192",
- "phone_verified": false
}, - "refresh_token": "string",
- "access_token": "string",
- "access_token_secret": "string",
- "last_sign_in_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "tenants": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Get an user
Retrieve user details.
Authorizations:
path Parameters
user_id required | string <uuid> (user_id) User Id. System generated uuid |
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=user_id,user_nickname |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=aggregates |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_nickname": "Bayaraa",
- "user_fullName": "Bayaraa Basan",
- "user_email_verified": true,
- "user_phone": "+1-202-555-0192",
- "user_phone_verified": true,
- "user_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "is_blocked": false,
- "is_invited": true,
- "invited_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "last_sign_in_at": null,
- "logins": 0,
- "identities": 0,
- "permissions": 0,
- "roles": 0,
- "tokens": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "identities": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "identity_provider": "aircampi",
- "user_identifier": "string",
- "identity_data": {
- "profile_picture": "string",
- "username": "string",
- "user_fullname": "string",
- "email_verified": false,
- "phone": "+1-202-555-0192",
- "phone_verified": false
}, - "refresh_token": "string",
- "access_token": "string",
- "access_token_secret": "string",
- "last_sign_in_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "tenants": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Update an user
Update an user
Authorizations:
path Parameters
user_id required | string <uuid> (user_id) User Id. System generated uuid |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Update an user
user_name | string Name of User |
user_description | string Description of User |
user_metadata | object (user_metadata) user's metadata structure |
Array of objects (app_metadata) application metadata structure for customize your needs. |
Responses
Request samples
- Payload
{- "user_name": "Changed User Name",
- "user_description": "Changed User Description",
- "user_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
]
}
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_nickname": "Bayaraa",
- "user_fullName": "Bayaraa Basan",
- "user_email_verified": true,
- "user_phone": "+1-202-555-0192",
- "user_phone_verified": true,
- "user_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "is_blocked": false,
- "is_invited": true,
- "invited_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "last_sign_in_at": null,
- "logins": 0,
- "identities": 0,
- "permissions": 0,
- "roles": 0,
- "tokens": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "identities": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "identity_provider": "aircampi",
- "user_identifier": "string",
- "identity_data": {
- "profile_picture": "string",
- "username": "string",
- "user_fullname": "string",
- "email_verified": false,
- "phone": "+1-202-555-0192",
- "phone_verified": false
}, - "refresh_token": "string",
- "access_token": "string",
- "access_token_secret": "string",
- "last_sign_in_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "tenants": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Block an user
Block an user
Authorizations:
path Parameters
user_id required | string <uuid> (user_id) User Id. System generated uuid |
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="user_id,id" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_nickname": "Bayaraa",
- "user_fullName": "Bayaraa Basan",
- "user_email_verified": true,
- "user_phone": "+1-202-555-0192",
- "user_phone_verified": true,
- "user_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "is_blocked": false,
- "is_invited": true,
- "invited_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "last_sign_in_at": null,
- "logins": 0,
- "identities": 0,
- "permissions": 0,
- "roles": 0,
- "tokens": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "identities": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "identity_provider": "aircampi",
- "user_identifier": "string",
- "identity_data": {
- "profile_picture": "string",
- "username": "string",
- "user_fullname": "string",
- "email_verified": false,
- "phone": "+1-202-555-0192",
- "phone_verified": false
}, - "refresh_token": "string",
- "access_token": "string",
- "access_token_secret": "string",
- "last_sign_in_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "tenants": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Unblock an user
Unblock an user
Authorizations:
path Parameters
user_id required | string <uuid> (user_id) User Id. System generated uuid |
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="user_id,id" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_nickname": "Bayaraa",
- "user_fullName": "Bayaraa Basan",
- "user_email_verified": true,
- "user_phone": "+1-202-555-0192",
- "user_phone_verified": true,
- "user_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "is_blocked": false,
- "is_invited": true,
- "invited_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "last_sign_in_at": null,
- "logins": 0,
- "identities": 0,
- "permissions": 0,
- "roles": 0,
- "tokens": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "identities": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "identity_provider": "aircampi",
- "user_identifier": "string",
- "identity_data": {
- "profile_picture": "string",
- "username": "string",
- "user_fullname": "string",
- "email_verified": false,
- "phone": "+1-202-555-0192",
- "phone_verified": false
}, - "refresh_token": "string",
- "access_token": "string",
- "access_token_secret": "string",
- "last_sign_in_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "tenants": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Get user roles
Get user roles
Authorizations:
path Parameters
user_id required | string <uuid> (user_id) User Id. System generated UUID |
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="user_id,role_id" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
q | string This query parameter defines the where clause. Example: ?q="user_id>1" |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort="instance_name asc,instance_description desc" |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Add an user to roles
Add an user to roles
Authorizations:
path Parameters
user_id required | string <uuid> (user_id) User Id. System generated UUID |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
List of Roles
roles | Array of strings <uuid> (role_id) |
Responses
Request samples
- Payload
{- "roles": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Remove an user from roles
Remove an user from roles
Authorizations:
path Parameters
user_id required | string <uuid> (user_id) User Id. System generated UUID. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
List of Roles
roles | Array of strings <uuid> (role_id) |
Responses
Request samples
- Payload
{- "roles": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Get user permissions
Get user permissions
Authorizations:
path Parameters
user_id required | string <uuid> (user_id) User Id. System generated UUID |
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="user_id,role_id" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
q | string This query parameter defines the where clause. Example: ?q="user_id>1" |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort="instance_name asc,instance_description desc" |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Add permissions to an user
Add permissions to an user
Authorizations:
path Parameters
user_id required | string <uuid> (user_id) User Id. System generated UUID |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
List of Permissions
Array of objects | |||
Array
|
Responses
Request samples
- Payload
{- "permissions": [
- {
- "scopes": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
]
}
Remove permissions from an user
Remove permissions from an user
Authorizations:
path Parameters
user_id required | string <uuid> (user_id) User Id. System generated UUID. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
List of Permissions
Array of objects | |||
Array
|
Responses
Request samples
- Payload
{- "permissions": [
- {
- "scopes": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
]
}
Get user groups
Get user groups
Authorizations:
path Parameters
user_id required | string <uuid> (user_id) User Id. System generated UUID |
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="user_id,group_id" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
q | string This query parameter defines the where clause. Example: ?q="user_id>1" |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort="instance_name asc,instance_description desc" |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Add an user to groups
Add an user to groups
Authorizations:
path Parameters
user_id required | string <uuid> (user_id) User Id. System generated UUID |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
List of Groups
groups | Array of strings <uuid> (group_id) |
Responses
Request samples
- Payload
{- "groups": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Remove an user from groups
Remove an user from groups
Authorizations:
path Parameters
user_id required | string <uuid> (user_id) User Id. System generated UUID. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
List of Groups
groups | Array of strings <uuid> (group_id) |
Responses
Request samples
- Payload
{- "groups": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Get user tenants
Get user tenants
Authorizations:
path Parameters
user_id required | string <uuid> (user_id) User Id. System generated UUID |
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="user_id,tenant_id" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
q | string This query parameter defines the where clause. Example: ?q="user_id>1" |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort="instance_name asc,instance_description desc" |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Add an user to tenants
Add an user to tenants
Authorizations:
path Parameters
user_id required | string <uuid> (user_id) User Id. System generated UUID |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
List of Tenants
tenants | Array of strings <uuid> (tenant_id) |
Responses
Request samples
- Payload
{- "tenants": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Remove an user from tenants
Remove an user from tenants
Authorizations:
path Parameters
user_id required | string <uuid> (user_id) User Id. System generated UUID. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
List of Tenants
tenants | Array of strings <uuid> (tenant_id) |
Responses
Request samples
- Payload
{- "tenants": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Get user's audit logs
Get user's audit logs
Authorizations:
path Parameters
user_id required | string <uuid> (user_id) User Id. System generated UUID |
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="user_id,id" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
q | string This query parameter defines the where clause. Example: ?q="user_id>1" |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort="instance_name asc,instance_description desc" |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "payload_data": {
- "event_group": "user_events",
- "event_type": "user_signedin",
- "event_date": "2019-08-24T14:15:22Z",
- "changes": [
- {
- "old_value": "string",
- "new_value": "string"
}
]
}, - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Get user's identities
Get user's identities
Authorizations:
path Parameters
user_id required | string <uuid> (user_id) User Id. System generated UUID |
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="user_id,id" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
q | string This query parameter defines the where clause. Example: ?q="user_id>1" |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort="instance_name asc,instance_description desc" |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "identity_provider": "aircampi",
- "user_identifier": "string",
- "identity_data": {
- "profile_picture": "string",
- "username": "string",
- "user_fullname": "string",
- "email_verified": false,
- "phone": "+1-202-555-0192",
- "phone_verified": false
}, - "refresh_token": "string",
- "access_token": "string",
- "access_token_secret": "string",
- "last_sign_in_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Link an user identity
Link an user identity
Authorizations:
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="user_id,id" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Create an user identity
identity_provider | string (identity_provider) Default: "aircampi" Enum: "aircampi" "google" "apple" "facebook" "twitter" "github" The name of the identity provider configured to your app. If aircampi, it will redirect to the Aircampi Login. |
user_identifier | string User identifier for specific identity provider |
Responses
Request samples
- Payload
{- "identity_provider": "aircampi",
- "user_identifier": "string"
}
Response samples
- 201
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "identity_provider": "aircampi",
- "user_identifier": "string",
- "identity_data": {
- "profile_picture": "string",
- "username": "string",
- "user_fullname": "string",
- "email_verified": false,
- "phone": "+1-202-555-0192",
- "phone_verified": false
}, - "refresh_token": "string",
- "access_token": "string",
- "access_token_secret": "string",
- "last_sign_in_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
Unlink an user identity
Unlink an user identity
Authorizations:
path Parameters
user_id required | string <uuid> (user_id) User Id. System generated UUID. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Delete an user identity
identity_provider | string (identity_provider) Default: "aircampi" Enum: "aircampi" "google" "apple" "facebook" "twitter" "github" The name of the identity provider configured to your app. If aircampi, it will redirect to the Aircampi Login. |
user_identifier | string User identifier for specific identity provider |
Responses
Request samples
- Payload
{- "identity_provider": "aircampi",
- "user_identifier": "string"
}
Get tenants
Retrieve filtered list of tenants.
Authorizations:
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="tenant_id,tenant_name" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
q | string This query parameter defines the where clause. Example: ?q="role_id>1" |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort="instance_name asc,instance_description desc" |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_name": "string",
- "tenant_description": "string",
- "tenant_metadata": {
- "branding": {
- "display_name": "string",
- "logo_url": "string"
}
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "users": 0,
- "invitations": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "identity_providers": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "identity_provider": "aircampi",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "members": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "is_blocked": false,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string",
- "role_description": "string",
- "role_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
], - "invitations": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "token_encrypted": "string",
- "expired_at": "2019-08-24T14:15:22Z",
- "user_limits": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Create a tenant
Create a tenant
Authorizations:
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="tenant_id,tenant_name" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Create a Tenant
tenant_name | string non-empty Name of Tenant |
tenant_description | string Description of Tenant |
Responses
Request samples
- Payload
{- "tenant_name": "Additional Tenant Name",
- "tenant_description": "Additional Tenant Description"
}
Response samples
- 201
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_name": "string",
- "tenant_description": "string",
- "tenant_metadata": {
- "branding": {
- "display_name": "string",
- "logo_url": "string"
}
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "users": 0,
- "invitations": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "identity_providers": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "identity_provider": "aircampi",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "members": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "is_blocked": false,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string",
- "role_description": "string",
- "role_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
], - "invitations": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "token_encrypted": "string",
- "expired_at": "2019-08-24T14:15:22Z",
- "user_limits": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Get a tenant
Retrieve tenant details.
Authorizations:
path Parameters
tenant_id required | string <uuid> (tenant_id) Tenant Id. System generated UUID |
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="tenant_id,tenant_name" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_name": "string",
- "tenant_description": "string",
- "tenant_metadata": {
- "branding": {
- "display_name": "string",
- "logo_url": "string"
}
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "users": 0,
- "invitations": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "identity_providers": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "identity_provider": "aircampi",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "members": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "is_blocked": false,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string",
- "role_description": "string",
- "role_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
], - "invitations": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "token_encrypted": "string",
- "expired_at": "2019-08-24T14:15:22Z",
- "user_limits": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Modify a tenant
Modify a tenant
Authorizations:
path Parameters
tenant_id required | string <uuid> (tenant_id) Tenant Id. System generated UUID |
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="tenant_id,tenant_name" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Update a Tenant
tenant_name | string Name of Tenant |
tenant_description | string Description of Tenant |
object (tenant_metadata) Tenant's metadata | |
Array of objects (app_metadata) application metadata structure for customize your needs. |
Responses
Request samples
- Payload
{- "tenant_name": "Changed Tenant Name",
- "tenant_description": "Changed Tenant Description",
- "tenant_metadata": {
- "branding": {
- "display_name": "string",
- "logo_url": "string"
}
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
]
}
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_name": "string",
- "tenant_description": "string",
- "tenant_metadata": {
- "branding": {
- "display_name": "string",
- "logo_url": "string"
}
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "users": 0,
- "invitations": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "identity_providers": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "identity_provider": "aircampi",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "members": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "is_blocked": false,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string",
- "role_description": "string",
- "role_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
], - "invitations": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "token_encrypted": "string",
- "expired_at": "2019-08-24T14:15:22Z",
- "user_limits": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Get tenant's identity providers
Get tenant's identity providers
Authorizations:
path Parameters
tenant_id required | string <uuid> (tenant_id) Tenant Id. System generated UUID |
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="invite_id" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
q | string This query parameter defines the where clause. Example: ?q="tenant_id>1" |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort="instance_name asc,instance_description desc" |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "identity_provider": "aircampi",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Add identity providers to a tenant
Add identity providers to a tenant
Authorizations:
path Parameters
tenant_id required | string <uuid> (tenant_id) Tenant Id. System generated UUID |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
List of Identity Providers
identity_providers | Array of strings (identity_provider) Items Enum: "aircampi" "google" "apple" "facebook" "twitter" "github" |
Responses
Request samples
- Payload
{- "identity_providers": [
- "aircampi"
]
}
Remove identity providers from a tenant
Remove identity providers from a tenant
Authorizations:
path Parameters
tenant_id required | string <uuid> (tenant_id) Tenant Id. System generated UUID. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
List of Identity Providers
identity_providers | Array of strings (identity_provider) Items Enum: "aircampi" "google" "apple" "facebook" "twitter" "github" |
Responses
Request samples
- Payload
{- "identity_providers": [
- "aircampi"
]
}
Get tenant members
Get tenant members
Authorizations:
path Parameters
tenant_id required | string <uuid> (tenant_id) Tenant Id. System generated UUID |
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="tenant_id,user_id" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
q | string This query parameter defines the where clause. Example: ?q="role_id>1" |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort="instance_name asc,instance_description desc" |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "is_blocked": false,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string",
- "role_description": "string",
- "role_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Add members to a tenant
Add members to a tenant
Authorizations:
path Parameters
tenant_id required | string <uuid> (tenant_id) Tenant Id. System generated UUID |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
List of Users
users | Array of strings <uuid> (user_id) |
Responses
Request samples
- Payload
{- "users": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Remove members from a tenant
Remove members from a tenant
Authorizations:
path Parameters
tenant_id required | string <uuid> (tenant_id) Tenant Id. System generated UUID. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
List of Users
users | Array of strings <uuid> (user_id) |
Responses
Request samples
- Payload
{- "users": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Block members to a tenant
Block members to a tenant
Authorizations:
path Parameters
tenant_id required | string <uuid> (tenant_id) Tenant Id. System generated UUID |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
List of Users
users | Array of strings <uuid> (user_id) |
Responses
Request samples
- Payload
{- "users": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Unblock members to a tenant
Unblock members to a tenant
Authorizations:
path Parameters
tenant_id required | string <uuid> (tenant_id) Tenant Id. System generated UUID |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
List of Users
users | Array of strings <uuid> (user_id) |
Responses
Request samples
- Payload
{- "users": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Get a tenant member
Retrieve member details.
Authorizations:
path Parameters
tenant_id required | string <uuid> (tenant_id) Tenant Id. System generated UUID |
user_id required | string <uuid> (user_id) User Id. System generated UUID |
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="tenant_id,tenant_name" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "is_blocked": false,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string",
- "role_description": "string",
- "role_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Modify a tenant member
Modify a tenant member
Authorizations:
path Parameters
tenant_id required | string <uuid> (tenant_id) Tenant Id. System generated UUID |
user_id required | string <uuid> (user_id) User Id. System generated UUID |
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="tenant_id,tenant_name" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Update a tenant member
expired_at | string <date-time> Invitation expiration date and time |
user_limits | integer Invitation user limits |
roles | Array of strings <uuid> (role_id) |
Responses
Request samples
- Payload
{- "expired_at": "2019-08-24T14:15:22Z",
- "user_limits": 0,
- "roles": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "is_blocked": false,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string",
- "role_description": "string",
- "role_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Delete a tenant member
Delete a tenant member
Authorizations:
path Parameters
tenant_id required | string <uuid> (tenant_id) The Tenant Id. System generated UUID that needs to be deleted |
user_id required | string <uuid> (user_id) User Id. System generated UUID that needs to be deleted |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Block a tenant user
Block a tenant user
Authorizations:
path Parameters
tenant_id required | string <uuid> (tenant_id) Tenant Id. System generated UUID |
user_id required | string <uuid> (user_id) User Id. System generated UUID |
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="tenant_id,user_id" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "is_blocked": false,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string",
- "role_description": "string",
- "role_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Unblock a tenant user
Unblock a tenant user
Authorizations:
path Parameters
tenant_id required | string <uuid> (tenant_id) Tenant Id. System generated UUID |
user_id required | string <uuid> (user_id) User Id. System generated UUID |
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="tenant_id,user_id" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "is_blocked": false,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string",
- "role_description": "string",
- "role_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Get member roles
Get the roles assigned to a tenant member
Authorizations:
path Parameters
tenant_id required | string <uuid> (tenant_id) Tenant Id. System generated UUID |
user_id required | string <uuid> (user_id) User Id. System generated UUID |
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="user_id,role_id" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
q | string This query parameter defines the where clause. Example: ?q="role_id>1" |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort="instance_name asc,instance_description desc" |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string",
- "role_description": "string",
- "role_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Add roles to a tenant's member
Assign one or more roles to a given user of the tenant
Authorizations:
path Parameters
tenant_id required | string <uuid> (tenant_id) Tenant Id. System generated UUID |
user_id required | string <uuid> (user_id) User Id. System generated UUID |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
List of Roles
roles | Array of strings <uuid> (role_id) |
Responses
Request samples
- Payload
{- "roles": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Remove roles from a tenant's member
Remove one or more roles from a given user of the tenant.
Authorizations:
path Parameters
tenant_id required | string <uuid> (tenant_id) Tenant Id. System generated UUID. |
user_id required | string <uuid> (user_id) User Id. System generated UUID. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
List of Roles
roles | Array of strings <uuid> (role_id) |
Responses
Request samples
- Payload
{- "roles": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Get tenant invitations
Get tenant invitations
Authorizations:
path Parameters
tenant_id required | string <uuid> (tenant_id) Tenant Id. System generated UUID |
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="invite_id" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
q | string This query parameter defines the where clause. Example: ?q="tenant_id>1" |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort="instance_name asc,instance_description desc" |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "token_encrypted": "string",
- "expired_at": "2019-08-24T14:15:22Z",
- "user_limits": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Create tenant invitation
Create tenant invitation
Authorizations:
path Parameters
tenant_id required | string <uuid> (tenant_id) Tenant Id. System generated UUID |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Create a tenant invitation
expired_at | string <date-time> Invitation expiration date and time |
user_limits | integer Invitation user limits |
roles | Array of strings <uuid> (role_id) |
Responses
Request samples
- Payload
{- "expired_at": "2019-08-24T14:15:22Z",
- "user_limits": 0,
- "roles": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Response samples
- 201
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "token_encrypted": "string",
- "expired_at": "2019-08-24T14:15:22Z",
- "user_limits": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
Get a tenant invitation
Retrieve invitation details.
Authorizations:
path Parameters
tenant_id required | string <uuid> (tenant_id) Tenant Id. System generated UUID |
invitation_id required | string <uuid> (tenant_invitation_id) Invitation Id. System generated UUID |
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="tenant_id,invitation_id" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "token_encrypted": "string",
- "expired_at": "2019-08-24T14:15:22Z",
- "user_limits": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
Modify a tenant invitation
Modify a tenant invitation
Authorizations:
path Parameters
tenant_id required | string <uuid> (tenant_id) Tenant Id. System generated UUID |
invitation_id required | string <uuid> (tenant_invitation_id) Invitation Id. System generated UUID |
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="tenant_id,invitation_id" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Update a tenant invitation
expired_at | string <date-time> Invitation expiration date and time |
user_limits | integer Invitation user limits |
roles | Array of strings <uuid> (role_id) |
Responses
Request samples
- Payload
{- "expired_at": "2019-08-24T14:15:22Z",
- "user_limits": 0,
- "roles": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "token_encrypted": "string",
- "expired_at": "2019-08-24T14:15:22Z",
- "user_limits": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
Delete a tenant invitation
Delete a tenant invitation
Authorizations:
path Parameters
tenant_id required | string <uuid> (tenant_id) The Tenant Id. System generated UUID that needs to be deleted |
invitation_id required | string <uuid> (tenant_invitation_id) Invitation Id. System generated UUID that needs to be deleted |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Get groups
Retrieve filtered list of groups.
Authorizations:
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="group_id,group_name" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
q | string This query parameter defines the where clause. Example: ?q="group_id>1" |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort="instance_name asc,instance_description desc" |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_name": "string",
- "group_description": "string",
- "parent_id": null,
- "group_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "users": 0,
- "roles": 0,
- "nested_groups": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "members": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string",
- "role_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "nested_groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_name": "string",
- "group_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "users": 0,
- "roles": 0,
- "nested_groups": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
]
}
Create a group
Create a group
Authorizations:
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="group_id,group_name" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Create a group
group_name | string non-empty Name of Group |
group_description | string Description of Group |
Responses
Request samples
- Payload
{- "group_name": "Additional Group Name",
- "group_description": "Additional Group Description"
}
Response samples
- 201
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_name": "string",
- "group_description": "string",
- "parent_id": null,
- "group_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "users": 0,
- "roles": 0,
- "nested_groups": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "members": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string",
- "role_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "nested_groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_name": "string",
- "group_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "users": 0,
- "roles": 0,
- "nested_groups": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
Get a group
Retrieve group details.
Authorizations:
path Parameters
group_id required | string <uuid> (group_id) Group Id. System generated UUID |
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="group_id,group_name" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_name": "string",
- "group_description": "string",
- "parent_id": null,
- "group_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "users": 0,
- "roles": 0,
- "nested_groups": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "members": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string",
- "role_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "nested_groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_name": "string",
- "group_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "users": 0,
- "roles": 0,
- "nested_groups": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
Modify a group
Modify a group
Authorizations:
path Parameters
group_id required | string <uuid> (group_id) Group Id. System generated UUID |
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="group_id,group_name" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Update a group
group_name | string Name of Group |
group_description | string Description of Group |
group_metadata | object (role_metadata) Role's metadata |
Array of objects (app_metadata) application metadata structure for customize your needs. |
Responses
Request samples
- Payload
{- "group_name": "Changed Group Name",
- "group_description": "Changed Group Description",
- "group_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
]
}
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_name": "string",
- "group_description": "string",
- "parent_id": null,
- "group_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "users": 0,
- "roles": 0,
- "nested_groups": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "members": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string",
- "role_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "nested_groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_name": "string",
- "group_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "users": 0,
- "roles": 0,
- "nested_groups": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
Delete a group
Delete a group
Authorizations:
path Parameters
group_id required | string <uuid> (group_id) Group Id. System generated UUID that needs to be deleted |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Delete a group
revoke_roles | boolean Default: false When true, System revokes all roles of the group from all members automatically. |
Responses
Request samples
- Payload
{- "revoke_roles": false
}
Move a group
Move a group to another group
Authorizations:
path Parameters
group_id required | string <uuid> (group_id) Group Id. System generated UUID |
query Parameters
fields | string Default: "" This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="group_id,parent_id" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Move a group to another group
parent_id | string <uuid> Group Id to be parent. Stay null, if you want a nesteg group to root. |
Responses
Request samples
- Payload
{- "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef"
}
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_name": "string",
- "group_description": "string",
- "parent_id": null,
- "group_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "users": 0,
- "roles": 0,
- "nested_groups": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "members": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string",
- "role_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "nested_groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_name": "string",
- "group_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "users": 0,
- "roles": 0,
- "nested_groups": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
Get group members
Get group members
Authorizations:
path Parameters
group_id required | string <uuid> (group_id) Group Id. System generated UUID |
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="group_id,user_id" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
q | string This query parameter defines the where clause. Example: ?q="group_id>1" |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort="instance_name asc,instance_description desc" |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Add members to a group
Add members to a group
Authorizations:
path Parameters
group_id required | string <uuid> (group_id) Group Id. System generated UUID |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Add members to a group
assign_roles | boolean Default: false When true, System assigns all roles of the group to passed members automatically. |
members | Array of strings <uuid> (user_id) non-empty List of Users to add |
Responses
Request samples
- Payload
{- "assign_roles": false,
- "members": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Remove members from a group
Remove members from a group
Authorizations:
path Parameters
group_id required | string <uuid> (group_id) Group Id. System generated UUID. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Remove members from a group
revoke_roles | boolean Default: false When true, System revokes all roles of the group from passed members automatically. |
members | Array of strings <uuid> (user_id) non-empty List of Users to remove |
Responses
Request samples
- Payload
{- "revoke_roles": false,
- "members": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Get nested groups
Get nested groups
Authorizations:
path Parameters
group_id required | string <uuid> (group_id) Group Id. System generated UUID |
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="group_id,parent_id" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
q | string This query parameter defines the where clause. Example: ?q="group_id>1" |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort="instance_name asc,instance_description desc" |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_name": "string",
- "group_description": "string",
- "parent_id": null,
- "group_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "users": 0,
- "roles": 0,
- "nested_groups": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "members": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string",
- "role_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "nested_groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_name": "string",
- "group_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "users": 0,
- "roles": 0,
- "nested_groups": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
]
}
Add nested groups
Add nested groups to a group
Authorizations:
path Parameters
group_id required | string <uuid> (group_id) Group Id. System generated UUID |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Add nested groups to a group
groups | Array of strings <uuid> (group_id) non-empty List of Groups to add as nested group |
Responses
Request samples
- Payload
{- "groups": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Delete nested groups
Delete nested groups
Authorizations:
path Parameters
group_id required | string <uuid> (group_id) Group Id. System generated UUID. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Remove nested groups from a group
revoke_roles | boolean Default: false When true, System revokes all roles of passed groups from all members of passed groups automatically. |
nested_groups | Array of strings <uuid> (group_id) non-empty List of Groups to remove |
Responses
Request samples
- Payload
{- "revoke_roles": false,
- "nested_groups": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Get group roles
Get group roles
Authorizations:
path Parameters
group_id required | string <uuid> (group_id) Group Id. System generated UUID |
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="group_id,role_id" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
q | string This query parameter defines the where clause. Example: ?q="group_id>1" |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort="instance_name asc,instance_description desc" |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Responses
Response samples
- 200
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string",
- "role_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Add roles to a group
Add roles to a group
Authorizations:
path Parameters
group_id required | string <uuid> (group_id) Group Id. System generated UUID |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Add roles to a group
assign_roles | boolean Default: false When true, System assigns roles to all members of the group automatically. |
roles | Array of strings <uuid> (role_id) non-empty List of Roles to add |
Responses
Request samples
- Payload
{- "assign_roles": false,
- "roles": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Remove roles from a group
Remove roles from a group
Authorizations:
path Parameters
group_id required | string <uuid> (group_id) Group Id. System generated UUID. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
Request Body schema: application/json
Remove roles from a group
revoke_roles | boolean Default: false When true, System revokes roles from all members of the group automatically. |
roles | Array of strings <uuid> (role_id) non-empty List of Roles to remove |
Responses
Request samples
- Payload
{- "revoke_roles": false,
- "roles": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Get Stats
Get Stats
Authorizations:
query Parameters
fields | string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields="instance_id,instance_metadata" |
expand | string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand="aggregates" |
q | string This query parameter defines the where clause. Example: ?q="instance_id>1" |
sort | string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort="instance_name asc,instance_description desc" |
offset | integer Default: 0 Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. |
limit | integer Default: 10 This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources. |
totalCount | boolean Default: false The resource collection representation will include the "estimated row count" when "?totalCount=true", otherwise the totalCount is not included. |
header Parameters
Authorization required | string Default: Bearer {{access_token}} Access Token |
instance_id | string <uuid> Instance Id. System generated UUID. If not provided, system thinks default instance. |
Responses
Response samples
- 200
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
- "stat_date": "2019-08-24",
- "stat_name": "active_users",
- "stat_value": "12K",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
Instance Models
id | string <uuid> (instance_id) Instance Id. System generated uuid |
instance_name | string Name of Instance |
instance_description | string Description of Instance |
object (instance_metadata) instance's metadata structure | |
Array of objects (app_metadata) application metadata structure for customize your needs. | |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
object (instance_aggregate) Instance Aggregated Info | |
Array of objects (user) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instance_name": "string",
- "instance_description": "string",
- "instance_metadata": {
- "identity_providers": [
- {
- "identity_provider": "aircampi",
- "enabled": true
}
], - "supported_locales": [
- "mn"
], - "password_validators": [
- {
- "order": 1,
- "validator": "default",
- "description": "Default Password Validator",
- "rules": "(?=^.{8,}$)(?=.*\\d)(?=.*[!@#$%^&*]+)(?![.\\n])(?=.*[A-Z])(?=.*[a-z]).*$"
}
]
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
- "clients": 0,
- "tenants": 0,
- "resources": 0,
- "users": 0,
- "roles": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "admins": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_nickname": "Bayaraa",
- "user_fullName": "Bayaraa Basan",
- "user_email_verified": true,
- "user_phone": "+1-202-555-0192",
- "user_phone_verified": true,
- "user_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "is_blocked": false,
- "is_invited": true,
- "invited_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "last_sign_in_at": null,
- "logins": 0,
- "identities": 0,
- "permissions": 0,
- "roles": 0,
- "tokens": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "identities": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "identity_provider": "aircampi",
- "user_identifier": "string",
- "identity_data": {
- "profile_picture": "string",
- "username": "string",
- "user_fullname": "string",
- "email_verified": false,
- "phone": "+1-202-555-0192",
- "phone_verified": false
}, - "refresh_token": "string",
- "access_token": "string",
- "access_token_secret": "string",
- "last_sign_in_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "tenants": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
id | string <uuid> (id) System generated uuid |
instance_id | string <uuid> (instance_id) Instance Id. System generated uuid |
clients | integer Default: 0 Number of Clients |
tenants | integer Default: 0 Number of Tenants |
resources | integer Default: 0 Number of Resources |
users | integer Default: 0 Number of Users |
roles | integer Default: 0 Number of Roles |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
- "clients": 0,
- "tenants": 0,
- "resources": 0,
- "users": 0,
- "roles": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
id | string <uuid> (id) System generated uuid |
instance_id | string <uuid> (instance_id) Instance Id. System generated uuid |
stat_date | string <date> Date of Statistics |
stat_name | string Name of Statistics |
stat_value | integer Statistic value |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
- "stat_date": "2019-08-24",
- "stat_name": "active_users",
- "stat_value": "12K",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
Resource Type: Collection Resource
totalCount | integer (Total Count) The total number of search records that match the query If you send request with query parameter ?totalCount=true only. Otherwise the totalCount is not included. |
count | integer (Count) The number of resource instances returned in the current range. |
hasMore | boolean (HasMore) Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. |
limit | integer (Limit) The actual paging size used by the server. |
offset | integer (Offset) Default: 10 The offset value used in the current page. |
Array of objects (instance) |
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instance_name": "string",
- "instance_description": "string",
- "instance_metadata": {
- "identity_providers": [
- {
- "identity_provider": "aircampi",
- "enabled": true
}
], - "supported_locales": [
- "mn"
], - "password_validators": [
- {
- "order": 1,
- "validator": "default",
- "description": "Default Password Validator",
- "rules": "(?=^.{8,}$)(?=.*\\d)(?=.*[!@#$%^&*]+)(?![.\\n])(?=.*[A-Z])(?=.*[a-z]).*$"
}
]
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
- "clients": 0,
- "tenants": 0,
- "resources": 0,
- "users": 0,
- "roles": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "admins": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_nickname": "Bayaraa",
- "user_fullName": "Bayaraa Basan",
- "user_email_verified": true,
- "user_phone": "+1-202-555-0192",
- "user_phone_verified": true,
- "user_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "is_blocked": false,
- "is_invited": true,
- "invited_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "last_sign_in_at": null,
- "logins": 0,
- "identities": 0,
- "permissions": 0,
- "roles": 0,
- "tokens": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "identities": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "identity_provider": "aircampi",
- "user_identifier": "string",
- "identity_data": {
- "profile_picture": "string",
- "username": "string",
- "user_fullname": "string",
- "email_verified": false,
- "phone": "+1-202-555-0192",
- "phone_verified": false
}, - "refresh_token": "string",
- "access_token": "string",
- "access_token_secret": "string",
- "last_sign_in_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "tenants": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
]
}
Client Models
id | string <uuid> (client_id) Client Id. System generated uuid |
client_name | string Name of Client |
client_secret | string Secret Key of Client |
client_secret_expires_at | string <date-time> Expiration Date of Secret Key |
client_description | string Description of Client |
object (client_metadata) Client's metadata structure | |
Array of objects (app_metadata) application metadata structure for customize your needs. | |
is_first_party | boolean Is first party? |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
object (client_aggregate) Client aggregate | |
Array of objects (client_permission) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "client_name": "Web App",
- "client_secret": "dksafjl3241894019lkj3241",
- "client_secret_expires_at": "2019-08-24T14:15:22Z",
- "client_description": "Web Client App",
- "client_metadata": {
- "app_type": "mobile",
- "grant_types": [
- "password"
], - "refresh_token": {
- "expiration_enabled": false,
- "expiration_lifetime": 2592000
}, - "mobile": {
- "ios": {
- "team_id": "9JA890OLNO",
- "app_id": "com.aircampi.bundle"
}, - "android": {
- "package_name": "com.example",
- "hash_keys": "D8: A0:83 : D9 : C1: B2:..."
}
}
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "is_first_party": true,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "permissions": 0,
- "resources": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
id | string <uuid> (id) System generated uuid |
client_id | string <uuid> (client_id) Client Id. System generated uuid |
permissions | integer Default: 0 Number of Permissions |
resources | integer Default: 0 Number of Resources |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "permissions": 0,
- "resources": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
Resource Type: Collection Resource
totalCount | integer (Total Count) The total number of search records that match the query If you send request with query parameter ?totalCount=true only. Otherwise the totalCount is not included. |
count | integer (Count) The number of resource instances returned in the current range. |
hasMore | boolean (HasMore) Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. |
limit | integer (Limit) The actual paging size used by the server. |
offset | integer (Offset) Default: 10 The offset value used in the current page. |
Array of objects (client) |
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "client_name": "Web App",
- "client_secret": "dksafjl3241894019lkj3241",
- "client_secret_expires_at": "2019-08-24T14:15:22Z",
- "client_description": "Web Client App",
- "client_metadata": {
- "app_type": "mobile",
- "grant_types": [
- "password"
], - "refresh_token": {
- "expiration_enabled": false,
- "expiration_lifetime": 2592000
}, - "mobile": {
- "ios": {
- "team_id": "9JA890OLNO",
- "app_id": "com.aircampi.bundle"
}, - "android": {
- "package_name": "com.example",
- "hash_keys": "D8: A0:83 : D9 : C1: B2:..."
}
}
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "is_first_party": true,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "permissions": 0,
- "resources": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Resource Models
id | string <uuid> (resource_id) Resource Id. System generated uuid |
resource_type | string (resource_type) Value: "API" Type of Resource |
resource_name | string Name of Resource |
resource_description | string Description of Resource |
object (resource_metadata) Resource's metadata | |
Array of objects (app_metadata) application metadata structure for customize your needs. | |
created_date | string <date-time> (created_at) Create at date and time |
updated_date | string <date-time> (updated_at) Updated at date and time |
object (resource_aggregate) Resource Aggregate | |
Array of objects (resource_scope) | |
Array of objects (resource_client) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_type": "API",
- "resource_name": "string",
- "resource_description": "string",
- "resource_metadata": {
- "api": {
- "identifier_url": "string",
- "expiration_lifetime": 2592000,
- "is_system": false
}, - "token": {
- "expiration_lifetime": 86400,
- "signing_algorithm": "HS256",
- "signing_secret": "string"
}, - "skip_consent_for_first_party": false
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_date": "2019-08-24T14:15:22Z",
- "updated_date": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scopes": 0,
- "clients": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "scopes": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_name": "string",
- "scope_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "clients": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "authorized": true,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
id | string <uuid> (id) System generated uuid |
resource_id | string <uuid> (resource_id) Resource Id. System generated uuid |
scopes | integer Default: 0 Number of Scopes |
clients | integer Default: 0 Number of Clients |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scopes": 0,
- "clients": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
id | string <uuid> (id) System generated uuid |
resource_id | string <uuid> (resource_id) Resource Id. System generated uuid |
scope_name | string non-empty Name of Scope |
scope_description | string Description of Scope |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_name": "string",
- "scope_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
id | string <uuid> (id) System generated uuid |
resource_id | string <uuid> (resource_id) Resource Id. System generated uuid |
client_id | string <uuid> (client_id) Client Id. System generated uuid |
authorized | boolean Default: true is authorized? |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "authorized": true,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
Resource Type: Collection Resource
totalCount | integer (Total Count) The total number of search records that match the query If you send request with query parameter ?totalCount=true only. Otherwise the totalCount is not included. |
count | integer (Count) The number of resource instances returned in the current range. |
hasMore | boolean (HasMore) Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. |
limit | integer (Limit) The actual paging size used by the server. |
offset | integer (Offset) Default: 10 The offset value used in the current page. |
Array of objects (resource) |
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_type": "API",
- "resource_name": "string",
- "resource_description": "string",
- "resource_metadata": {
- "api": {
- "identifier_url": "string",
- "expiration_lifetime": 2592000,
- "is_system": false
}, - "token": {
- "expiration_lifetime": 86400,
- "signing_algorithm": "HS256",
- "signing_secret": "string"
}, - "skip_consent_for_first_party": false
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_date": "2019-08-24T14:15:22Z",
- "updated_date": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scopes": 0,
- "clients": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "scopes": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_name": "string",
- "scope_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "clients": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "authorized": true,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Role Models
id | string <uuid> (role_id) Role Id. System generated uuid |
role_name | string non-empty Name of Role |
role_description | string Description of Role |
role_metadata | object (role_metadata) Role's metadata |
Array of objects (app_metadata) application metadata structure for customize your needs. | |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
object (role_aggregate) Role Aggregate | |
Array of objects (role_permission) | |
Array of objects (role_member) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_name": "string",
- "role_description": "string",
- "role_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "permissions": 0,
- "users": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "members": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
id | string <uuid> (id) System generated uuid |
role_id | string <uuid> (role_id) Role Id. System generated uuid |
permissions | integer Default: 0 Number of Permissions |
users | integer Default: 0 Number of Users |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "permissions": 0,
- "users": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
id | string <uuid> (id) System generated uuid |
role_id | string <uuid> (role_id) Role Id. System generated uuid |
resource_id | string <uuid> (resource_id) Resource Id. System generated uuid |
scope_id | string <uuid> (scope_id) Resource Scope Id. System generated uuid |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
Resource Type: Collection Resource
totalCount | integer (Total Count) The total number of search records that match the query If you send request with query parameter ?totalCount=true only. Otherwise the totalCount is not included. |
count | integer (Count) The number of resource instances returned in the current range. |
hasMore | boolean (HasMore) Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. |
limit | integer (Limit) The actual paging size used by the server. |
offset | integer (Offset) Default: 10 The offset value used in the current page. |
Array of objects (role) |
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_name": "string",
- "role_description": "string",
- "role_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "permissions": 0,
- "users": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "members": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
id | string <uuid> (user_id) User Id. System generated uuid |
user_nickname | string >= 200 characters Nickname of User |
user_fullName | string >= 200 characters Fullname of User |
user_picture | string <url> Picture URL of User |
user_email | string <email> Email address of User |
user_email_verified | boolean Email address verified? |
user_phone | string/^\+(?:[0-9]-?){6,14}[0-9]$/ User phone number in international format |
user_phone_verified | boolean Phone number verified? |
user_metadata | object (user_metadata) user's metadata structure |
Array of objects (app_metadata) application metadata structure for customize your needs. | |
is_blocked | boolean User blocked? |
is_invited | boolean User invited? |
invited_at | string <date-time> User invited date and time |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
object (user_aggregate) User Aggregated Info | |
Array of objects (user_identity) | |
Array of objects (user_role) | |
Array of objects (user_permission) | |
Array of objects (user_group) | |
Array of objects (user_tenant) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_nickname": "Bayaraa",
- "user_fullName": "Bayaraa Basan",
- "user_email_verified": true,
- "user_phone": "+1-202-555-0192",
- "user_phone_verified": true,
- "user_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "is_blocked": false,
- "is_invited": true,
- "invited_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "last_sign_in_at": null,
- "logins": 0,
- "identities": 0,
- "permissions": 0,
- "roles": 0,
- "tokens": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "identities": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "identity_provider": "aircampi",
- "user_identifier": "string",
- "identity_data": {
- "profile_picture": "string",
- "username": "string",
- "user_fullname": "string",
- "email_verified": false,
- "phone": "+1-202-555-0192",
- "phone_verified": false
}, - "refresh_token": "string",
- "access_token": "string",
- "access_token_secret": "string",
- "last_sign_in_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "tenants": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
id | string <uuid> (id) System generated uuid |
user_id | string <uuid> (user_id) User Id. System generated uuid |
last_sign_in_at | string <date-time> Default: null Last Signed-in date and time |
logins | integer Default: 0 Number of Login times |
identities | integer Default: 0 Number of Identities |
permissions | integer Default: 0 Number of Permissions assigned |
roles | integer Default: 0 Number of Roles assigned |
tokens | integer Default: 0 Number of Tokens generated |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "last_sign_in_at": null,
- "logins": 0,
- "identities": 0,
- "permissions": 0,
- "roles": 0,
- "tokens": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
id | string <uuid> (id) System generated uuid |
user_id | string <uuid> (user_id) User Id. System generated uuid |
object Payload data | |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "payload_data": {
- "event_group": "user_events",
- "event_type": "user_signedin",
- "event_date": "2019-08-24T14:15:22Z",
- "changes": [
- {
- "old_value": "string",
- "new_value": "string"
}
]
}, - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
id | string <uuid> (id) System generated uuid |
user_id | string <uuid> (user_id) User Id. System generated uuid |
identity_provider | string (identity_provider) Default: "aircampi" Enum: "aircampi" "google" "apple" "facebook" "twitter" "github" The name of the identity provider configured to your app. If aircampi, it will redirect to the Aircampi Login. |
user_identifier | string user identifier for identity provider |
object (identity_data) Identity Data | |
refresh_token | string Refresh Token |
access_token | string Access Token |
access_token_secret | string Access Token Secret |
last_sign_in_at | string <date-time> Last signed-in date and time using this provider. |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "identity_provider": "aircampi",
- "user_identifier": "string",
- "identity_data": {
- "profile_picture": "string",
- "username": "string",
- "user_fullname": "string",
- "email_verified": false,
- "phone": "+1-202-555-0192",
- "phone_verified": false
}, - "refresh_token": "string",
- "access_token": "string",
- "access_token_secret": "string",
- "last_sign_in_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
id | string <uuid> (id) System generated uuid |
user_id | string <uuid> (user_id) User Id. System generated uuid |
resource_id | string <uuid> (resource_id) Resource Id. System generated uuid |
scope_id | string <uuid> (scope_id) Resource Scope Id. System generated uuid |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
id | string <uuid> (id) System generated uuid |
user_id | string <uuid> (user_id) User Id. System generated uuid |
role_id | string <uuid> (role_id) Role Id. System generated uuid |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
id | string <uuid> (id) System generated uuid |
user_id | string <uuid> (user_id) User Id. System generated uuid |
client_id | string <uuid> (client_id) Client Id. System generated uuid |
token_type | string Enum: "PASSWORD_RESET" "ACCESS_TOKEN" "REFRESH_TOKEN" Token Type |
token_encrypted | string Encrypted token |
token_revoked | boolean Default: false Token revoked? |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "token_type": "PASSWORD_RESET",
- "token_encrypted": "string",
- "token_revoked": false,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
Resource Type: Collection Resource
totalCount | integer (Total Count) The total number of search records that match the query If you send request with query parameter ?totalCount=true only. Otherwise the totalCount is not included. |
count | integer (Count) The number of resource instances returned in the current range. |
hasMore | boolean (HasMore) Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. |
limit | integer (Limit) The actual paging size used by the server. |
offset | integer (Offset) Default: 10 The offset value used in the current page. |
Array of objects (user) The users in the collection. |
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_nickname": "Bayaraa",
- "user_fullName": "Bayaraa Basan",
- "user_email_verified": true,
- "user_phone": "+1-202-555-0192",
- "user_phone_verified": true,
- "user_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "is_blocked": false,
- "is_invited": true,
- "invited_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "last_sign_in_at": null,
- "logins": 0,
- "identities": 0,
- "permissions": 0,
- "roles": 0,
- "tokens": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "identities": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "identity_provider": "aircampi",
- "user_identifier": "string",
- "identity_data": {
- "profile_picture": "string",
- "username": "string",
- "user_fullname": "string",
- "email_verified": false,
- "phone": "+1-202-555-0192",
- "phone_verified": false
}, - "refresh_token": "string",
- "access_token": "string",
- "access_token_secret": "string",
- "last_sign_in_at": "2019-08-24T14:15:22Z",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "permissions": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
- "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "tenants": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Tenant Models
id | string <uuid> (tenant_id) Tenant Id. System generated uuid |
tenant_name | string non-empty Name of Tenant |
tenant_description | string Description of Tenant |
object (tenant_metadata) Tenant's metadata | |
Array of objects (app_metadata) application metadata structure for customize your needs. | |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
object (tenant_aggregate) Tenant Aggregate | |
Array of objects (tenant_identity_provider) | |
Array of objects (tenant_member) | |
Array of objects (tenant_invitation) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_name": "string",
- "tenant_description": "string",
- "tenant_metadata": {
- "branding": {
- "display_name": "string",
- "logo_url": "string"
}
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "users": 0,
- "invitations": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "identity_providers": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "identity_provider": "aircampi",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "members": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "is_blocked": false,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string",
- "role_description": "string",
- "role_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
], - "invitations": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "token_encrypted": "string",
- "expired_at": "2019-08-24T14:15:22Z",
- "user_limits": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
id required | string <uuid> (id) System generated uuid |
tenant_id required | string <uuid> (tenant_id) Tenant Id. System generated uuid |
users | integer Default: 0 Number of Users |
invitations | integer Default: 0 Number of Invites |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "users": 0,
- "invitations": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
id | string <uuid> (id) System generated uuid |
tenant_id | string <uuid> (tenant_id) Tenant Id. System generated uuid |
user_id | string <uuid> (user_id) User Id. System generated uuid |
is_blocked | boolean Default: false is blocked? |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
Array of objects (tenant_member_role) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "is_blocked": false,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string",
- "role_description": "string",
- "role_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
id | string <uuid> (id) System generated uuid |
tenant_id | string <uuid> (tenant_id) Tenant Id. System generated uuid |
user_id | string <uuid> (user_id) User Id. System generated uuid |
role_id | string <uuid> (role_id) Role Id. System generated uuid |
role_name | string Name of Role |
role_description | string Description of Role |
role_metadata | object (role_metadata) Role's metadata |
Array of objects (app_metadata) application metadata structure for customize your needs. | |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string",
- "role_description": "string",
- "role_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
id | string <uuid> (id) System generated uuid |
tenant_id | string <uuid> (tenant_id) Tenant Id. System generated uuid |
token_encrypted | string Encrypted Token |
expired_at | string <date-time> Expiration Date and Time for Token. It can be null. |
user_limits | integer Number of Users to limit. It can be Null. |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "token_encrypted": "string",
- "expired_at": "2019-08-24T14:15:22Z",
- "user_limits": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
Resource Type: Collection Resource
totalCount | integer (Total Count) The total number of search records that match the query If you send request with query parameter ?totalCount=true only. Otherwise the totalCount is not included. |
count | integer (Count) The number of resource instances returned in the current range. |
hasMore | boolean (HasMore) Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. |
limit | integer (Limit) The actual paging size used by the server. |
offset | integer (Offset) Default: 10 The offset value used in the current page. |
Array of objects (tenant) |
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_name": "string",
- "tenant_description": "string",
- "tenant_metadata": {
- "branding": {
- "display_name": "string",
- "logo_url": "string"
}
}, - "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "users": 0,
- "invitations": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "identity_providers": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "identity_provider": "aircampi",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "members": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "is_blocked": false,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string",
- "role_description": "string",
- "role_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
], - "invitations": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
- "token_encrypted": "string",
- "expired_at": "2019-08-24T14:15:22Z",
- "user_limits": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Group Models
Resource Type: Single Resource
Fields:
- id
- group_name
- group_description
- parent_id
- group_metadata
- app_metadata
- created_at
- updated_at
Child Resources:
- aggregates
- members
- roles
- nested groups
id | string <uuid> (group_id) Group Id. System generated uuid |
group_name | string non-empty Name of Group |
group_description | string Description of Group |
parent_id | string <uuid> Default: null Parent Group Id. Nested Group must have a parent group. Otherwise, null (Root Group) |
group_metadata | object (group_metadata) Group's metadata |
Array of objects (app_metadata) application metadata structure for customize your needs. | |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
object (group_aggregate) Group Aggregate | |
Array of objects (group_member) | |
Array of objects (group_role) | |
Array of objects (nested_group) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_name": "string",
- "group_description": "string",
- "parent_id": null,
- "group_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "users": 0,
- "roles": 0,
- "nested_groups": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "members": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string",
- "role_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "nested_groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_name": "string",
- "group_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "users": 0,
- "roles": 0,
- "nested_groups": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
Resource Type: Single Resource
Fields:
- id
- group_id
- users
- roles
- nested_groups
- created_at
- updated_at
Child Resources:
No child resources.
id | string <uuid> (id) System generated uuid |
group_id | string <uuid> (group_id) Group Id. System generated uuid |
users | integer Default: 0 Number of Users |
roles | integer Default: 0 Number of Roles |
nested_groups | integer Default: 0 Number of Nested Groups |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "users": 0,
- "roles": 0,
- "nested_groups": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
id | string <uuid> (id) System generated uuid |
group_id | string <uuid> (group_id) Group Id. System generated uuid |
user_id | string <uuid> (user_id) User Id. System generated uuid |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
id | string <uuid> (id) System generated uuid |
group_id | string <uuid> (group_id) Group Id. System generated uuid |
role_id | string <uuid> (role_id) Role Id. System generated uuid |
role_name | string Name of Role |
role_description | string Description of Role |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string",
- "role_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
id | string <uuid> (group_id) Group Id. System generated uuid |
group_name | string non-empty Name of Nested Group |
group_description | string Description of Nested Group |
created_by | string <uuid> (user_id) User Id. System generated uuid |
created_at | string <date-time> (created_at) Create at date and time |
updated_by | string <uuid> (user_id) User Id. System generated uuid |
updated_at | string <date-time> (updated_at) Updated at date and time |
object (group_aggregate) Group Aggregate |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_name": "string",
- "group_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "users": 0,
- "roles": 0,
- "nested_groups": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Resource Type: Collection Resource
totalCount | integer (Total Count) The total number of search records that match the query If you send request with query parameter ?totalCount=true only. Otherwise the totalCount is not included. |
count | integer (Count) The number of resource instances returned in the current range. |
hasMore | boolean (HasMore) Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. |
limit | integer (Limit) The actual paging size used by the server. |
offset | integer (Offset) Default: 10 The offset value used in the current page. |
Array of objects (group) |
{- "totalCount": 0,
- "count": 0,
- "hasMore": true,
- "limit": 0,
- "offset": 10,
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_name": "string",
- "group_description": "string",
- "parent_id": null,
- "group_metadata": { },
- "app_metadata": [
- {
- "key": "language",
- "value": "Mongolian"
}
], - "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "users": 0,
- "roles": 0,
- "nested_groups": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "members": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "roles": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
- "role_name": "string",
- "role_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "nested_groups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_name": "string",
- "group_description": "string",
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z",
- "aggregates": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
- "users": 0,
- "roles": 0,
- "nested_groups": 0,
- "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
]
}
]
}