Included Routes

GET /builtins/status

get basic status information about authentication provider state of the service

Example request:

GET /builtins/status HTTP/1.1
Host: example.com

Status Codes

200 OK –

reports status of service including name and whether there is an enabled auth provider

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "name": "string",
    "auth_provider_initialized": true,
    "auth_db_initialized": true
}

POST /builtins/auth

obtain a token (login)

Example request:

POST /builtins/auth HTTP/1.1
Host: example.com
Content-Type: application/json

{}

Status Codes

200 OK –

successful login

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "token": "string",
    "token_data": {
        "cid": "string",
        "r": [
            "string"
        ],
        "cts": "string",
        "ets": "string",
        "rcid": "string",
        "tid": "string"
    }
}

GET /builtins/auth

get information about current authenticated token

Example request:

GET /builtins/auth HTTP/1.1
Host: example.com

Status Codes

200 OK –

successfully return of token data

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "cid": "string",
    "r": [
        "string"
    ],
    "cts": "string",
    "ets": "string",
    "rcid": "string",
    "tid": "string"
}

DELETE /builtins/auth

revoke current authenticated token (logout)

Status Codes

204 No Content – successfully revoked current token

GET /builtins/auth/tokens

get listing of all tokens for current authenticated client

Query Parameters

roles (array) –
exclude_expired (boolean) –

Example request:

GET /builtins/auth/tokens HTTP/1.1
Host: example.com

Status Codes

200 OK –

tokens returned successfully

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "cid": "string",
        "r": [
            "string"
        ],
        "cts": "string",
        "ets": "string",
        "rcid": "string",
        "tid": "string"
    }
]

POST /builtins/auth/tokens

create a token for the current authenticated client or target client

Example request:

POST /builtins/auth/tokens HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "client_id": "string",
    "roles": [
        "string"
    ],
    "token_life": 1
}

Status Codes

201 Created –

token created

Example response:

HTTP/1.1 201 Created
Content-Type: application/json

{
    "cid": "string",
    "r": [
        "string"
    ],
    "cts": "string",
    "ets": "string",
    "rcid": "string",
    "tid": "string"
}

DELETE /builtins/auth/tokens

revoke tokens for the current authenticated clients

Status Codes

204 No Content – tokens removed successfully

GET /builtins/auth/tokens/all

get tokens for all clients in auth database

Query Parameters

roles (array) –
exclude_expired (boolean) –
client_ids (array) –

Example request:

GET /builtins/auth/tokens/all HTTP/1.1
Host: example.com

Status Codes

200 OK –

tokens returned successfully

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "cid": "string",
        "r": [
            "string"
        ],
        "cts": "string",
        "ets": "string",
        "rcid": "string",
        "tid": "string"
    }
]

DELETE /builtins/auth/tokens/all

delete tokens for all clients in auth database

Status Codes

204 No Content – tokens deleted successfully

POST /builtins/auth/tokens/cleanup

initiate cleanup operation for expired tokens

Status Codes

204 No Content – the cleanup operation was initiated

GET /builtins/auth/tokens/{token_id}

get information on a specific token by token_id

Parameters

token_id (string) –

Example request:

GET /builtins/auth/tokens/{token_id} HTTP/1.1
Host: example.com

Status Codes

200 OK –

successfully return of token data

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "cid": "string",
    "r": [
        "string"
    ],
    "cts": "string",
    "ets": "string",
    "rcid": "string",
    "tid": "string"
}

DELETE /builtins/auth/tokens/{token_id}

revoke a token by token id

Parameters

token_id (string) –

Status Codes

204 No Content – token deleted successfully

GET /builtins/auth/clients

get authenticated client information from auth provider

Example request:

GET /builtins/auth/clients HTTP/1.1
Host: example.com

Status Codes

200 OK –

the client data is returned successfully

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "client_id": "string",
    "roles": [
        "string"
    ]
}

POST /builtins/auth/clients

authenticated client update own information in auth provider

Example request:

POST /builtins/auth/clients HTTP/1.1
Host: example.com
Content-Type: application/json

{}

Status Codes

200 OK –

the client was updated successfully

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "client_id": "string",
    "roles": [
        "string"
    ]
}

POST /builtins/auth/clients/create

create a client in the auth provider

Example request:

POST /builtins/auth/clients/create HTTP/1.1
Host: example.com
Content-Type: application/json

{}

Status Codes

201 Created –

the client was created successfully

Example response:

HTTP/1.1 201 Created
Content-Type: application/json

{
    "client_id": "string",
    "roles": [
        "string"
    ]
}

POST /builtins/auth/clients/register

allow a client to register itself in the auth provider

Example request:

POST /builtins/auth/clients/register HTTP/1.1
Host: example.com
Content-Type: application/json

{}

Status Codes

201 Created –

the client was created successfully

Example response:

HTTP/1.1 201 Created
Content-Type: application/json

{
    "client_id": "string",
    "roles": [
        "string"
    ]
}

GET /builtins/auth/clients/all

return list of all clients in the auth provider

Query Parameters

roles (array) –

Example request:

GET /builtins/auth/clients/all HTTP/1.1
Host: example.com

Status Codes

200 OK –

the clients were returned successfully

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "client_id": "string",
        "roles": [
            "string"
        ]
    }
]

GET /builtins/auth/clients/{client_id}

get auth provider information for a specific client

Parameters

client_id (string) –

Example request:

GET /builtins/auth/clients/{client_id} HTTP/1.1
Host: example.com

Status Codes

200 OK –

the client data was returned

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "client_id": "string",
    "roles": [
        "string"
    ]
}

POST /builtins/auth/clients/{client_id}

change auth provider information for the client

Parameters

client_id (string) –

Example request:

POST /builtins/auth/clients/{client_id} HTTP/1.1
Host: example.com
Content-Type: application/json

{}

Status Codes

200 OK –

the client data was returned

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "client_id": "string",
    "roles": [
        "string"
    ]
}

DELETE /builtins/auth/clients/{client_id}

delete the client from the auth provider

Parameters

client_id (string) –

Status Codes

204 No Content – the client was deleted

DELETE /builtins/auth/clients/{client_id}/roles

remove all roles from a the client

Parameters

client_id (string) –

Status Codes

204 No Content – all roles removed

POST /builtins/auth/clients/{client_id}/roles/{role}

add a specific role to the client

Parameters

client_id (string) –
role (string) –

Status Codes

204 No Content – the role was added

DELETE /builtins/auth/clients/{client_id}/roles/{role}

remove a specific role from the client

Parameters

client_id (string) –
role (string) –

Status Codes

204 No Content – the role was removed

POST /builtins/auth/clients/{client_id}/enable

enable the client in the auth provider

Parameters

client_id (string) –
role (string) –

Status Codes

204 No Content – the client was enabled

POST /builtins/auth/clients/{client_id}/disable

disable the client in the auth provider

Parameters

client_id (string) –
role (string) –

Status Codes

204 No Content – the client was disabled