Admin Actions
Administrative actions create, modify, or delete XINA data structures, perform user management, or other system functions.
Schema Actions
SCHEMA
Returns the complete environment schema as a JSON object.
Property | Value | Required | Default |
---|---|---|---|
action | "schema" |
yes |
Example
{
"action" : "schema"
}
The server will return a JSON object:
{
"groups" : [ ... ]
}
CREATE
CreatesThe CREATE action is used to create new groups, databases, teams, and databases.users.
CREATE GROUP
Creates a new group.
Property | Value | Required | Default |
---|---|---|---|
action |
|
yes | |
create | "group" |
yes | |
group | group definition |
yes | |
parent | group specifier | no |
CREATE DATABASE
{
"action" : "create",
"create" : "database",
"parent" : <group or database>
"database" : <database definition>
}
CREATE TEAM
{
"action" : "create",
"create" : "team",
"team" : <team definition>
}
ALTER
Edit group, database, team, or user properties.
Under Construction
DROP
Permanently delete teams, groups, databases, or users.
Under Construction
JOIN
LEAVE
User Actions
GRANT
REVOKE
REQUEST
Request an arbitrary action to be performed by a user with required permissions.
RETRACT
Retract one or more user requests.
APPROVE
REJECT
System Functions
ACCESS
Used to acquire temporary access ID for websocket connection.
Example
{
"action" : "access"
}
Result
{
"access_id" : "<string>"
"expires" : <unix_ms_timestamp>
}