Openid Connect

List of oidc clients

HOST: https://api.mixapp.io

Path: /v1/oidc/:workplace/registration

workplace - workplace name

Method: GET

Headers:

    Content-Type: application/json
    Authorization: Bearer <OIDC_TOKEN>

OIDCTOKEN - Secret token from oidc settings workplace

Query:

Body:

Response:

Success

[ { "client_id": "59dd29d8574e741c966c73f0", "application_type": "native", "response_types": ["code"], "scopes": [], "client_secret": "<secret_string>", "redirect_uris": [ "http://localhost:8080", "http://localhost:8081" ], "post_logout_redirect_uris": [ "http://localhost:8082" ], "client_secret_expires_at": 0, "client_name": "", "contacts": [], "logo_uri": "", "client_uri": "", "tos_uri": "", "policy_uri": "" } ]

Error

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

Getting oidc client

HOST: https://api.mixapp.io

Path: /v1/oidc/:workplace/registration

workplace - workplace name

Method: GET

Headers:

    Authorization: Bearer <OIDC_TOKEN>

OIDCTOKEN - Secret token from oidc settings workplace

Query:

client_id=<client_id>

client_id - Id of oidc client

Body:

Response:

Success

{ "client_id": "59dd29d8574e741c966c73f0", "application_type": "native", "response_types": ["code"], "scopes": [], "client_secret": "<secret_string>", "redirect_uris": [ "http://localhost:8080", "http://localhost:8081" ], "post_logout_redirect_uris": [ "http://localhost:8082" ], "client_secret_expires_at": 0, "client_name": "", "contacts": [], "logo_uri": "", "client_uri": "", "tos_uri": "", "policy_uri": "" }

Error

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

Creating oidc client

HOST: https://api.mixapp.io

Path: /v1/oidc/:workplace/registration

workplace - workplace name

Method: POST

Headers:

    Content-Type: application/json
    Authorization: Bearer <OIDC_TOKEN>

OIDCTOKEN - Secret token from oidc settings workplace

Query:

Body:

{        
        "application_type": "native",
        "response_types": ["code"],
        "scopes": [
            {
                "name": "roles",
                "desc": "User roles",
                "fields": ["roles"]
            }
        ],
        "redirect_uris": [
            "http://localhost:8080",
            "http://localhost:8081"
        ],
        "post_logout_redirect_uris": [
            "http://localhost:8082"
        ],
        "client_secret_expires_at": 0,
        "client_name": "",
        "contacts": [],
        "logo_uri": "",
        "client_uri": "",
        "tos_uri": "",
        "policy_uri": ""
    }

Response:

Success

{ "client_id": "59dd29d8574e741c966c73f0", "application_type": "native", "response_types": ["code"], "scopes": [ { "name": "roles", "desc": "User roles", "fields": ["roles"] } ], "client_secret": "<secret_string>", "redirect_uris": [ "http://localhost:8080", "http://localhost:8081" ], "post_logout_redirect_uris": [ "http://localhost:8082" ], "client_secret_expires_at": 0, "client_name": "", "contacts": [], "logo_uri": "", "client_uri": "", "tos_uri": "", "policy_uri": "" }

Error

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

Updating oidc client

HOST: https://api.mixapp.io

Path: /v1/oidc/:workplace/registration

workplace - workplace name

Method: POST

Headers:

    Content-Type: application/json
    Authorization: Bearer <OIDC_TOKEN>

OIDCTOKEN - Secret token from oidc settings workplace

Query:

client_id=<client_id>

client_id - Id of oidc client

Body:

{        
    "application_type": "native",
    "response_types": ["code"],
    "scopes": [
        {
            "name": "roles",
            "desc": "User roles",
            "fields": ["roles"]
        }
    ],
    "redirect_uris": [
        "http://localhost:8080"
    ],
    "post_logout_redirect_uris": [
        "http://localhost:8082"
    ],
    "client_secret_expires_at": 0,
    "client_name": "",
    "contacts": [],
    "logo_uri": "",
    "client_uri": "",
    "tos_uri": "",
    "policy_uri": "",
    "generate_token": false
}

generate_token - if set to true, will be generate a new secret key

Response:

Success

{ "application_type": "native", "response_types": ["code"], "scopes": [ { "name": "roles", "desc": "User roles", "fields": ["roles"] } ], "redirect_uris": [ "http://localhost:8080" ], "post_logout_redirect_uris": [ "http://localhost:8082" ], "client_secret_expires_at": 0, "client_name": "", "contacts": [], "logo_uri": "", "client_uri": "", "tos_uri": "", "policy_uri": "" }

Error

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

Removing oidc client

HOST: https://api.mixapp.io

Path: /v1/oidc/:workplace/registration

workplace - workplace name

Method: DELETE

Headers:

    Content-Type: application/json
    Authorization: Bearer <OIDC_TOKEN>

OIDCTOKEN - Secret token from oidc settings workplace

Query:

client_id=<client_id>

client_id - Id of oidc client

Body:

Response:

Success

{ result: true }

Error

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