Working with workplaces

Creating a workplace

HOST: https://api.mixapp.io

Path: /v1/workplaces

Method: POST

Headers:

Content-Type: application/json
X-Auth-Token: <Token>

Body:

{
    "name":"UniqueWorkplaceName"
}

Response:

Success

{ "result": { "name": "unique" } }

Error

JSON { error_code: int, error_message: string, more_info: "" }

Requesting information about the workplace

HOST: https://api.mixapp.io

Path: /v1/workplaces/:name

name - workplace name

Method: GET

Headers:

Content-Type: application/json
X-Auth-Token: <Token>

Body:

Response:

Success

{ "result": { "name": "unique" } }

Error

JSON { error_code: int, error_message: string, more_info: "" }

Deleting the workplace

HOST: https://api.mixapp.io

Path: /v1/workplaces/:name

name - workplace name

Method: DELETE

Headers:

Content-Type: application/json
X-Auth-Token: <Token>

Body:

Response:

Success

{ "result": true }

Error

JSON { error_code: int, error_message: string, more_info: "" }

Getting OIDC settings

HOST: https://api.mixapp.io

Path: /v1/workplaces/:name/oidc

name - workplace name

Method: GET

Headers:

X-Auth-Token: <Token>

Body:

Response:

Success

{ "result": { "collection": "users", "token": "<secret_string>" } }

Error

JSON { error_code: int, error_message: string, more_info: "" }

Updating OIDC settings

HOST: https://api.mixapp.io

Path: /v1/workplaces/:name/oidc

name - workplace name

Method: POST

Headers:

Content-Type: application/json
X-Auth-Token: <Token>

Body:

{collection: 'user_list'}

Response:

Success

{ "result": { "collection": "user_list", "token": "<secret_string>" } }

Error

JSON { error_code: int, error_message: string, more_info: "" }

Generate a new token for OIDC

HOST: https://api.mixapp.io

Path: /v1/workplaces/:name/oidc/token

name - workplace name

Method: POST

Headers:

Content-Type: application/json
X-Auth-Token: <Token>

Body:

Response:

Success

{ "result": { "collection": "user_list", "token": "<secret_string>" } }

Error

JSON { error_code: int, error_message: string, more_info: "" }