List All Roles

This API endpoint retrieves the all roles for a organization by using the client ID provided as a query parameter.

API Name: List All Roles

Method: GET

API Endpoint: https://api.ssojet.com/api/v1/users/roles

Parameters:

client_id: (string) The client ID for which the roles are to be retrieved.

Response Status Code

200 OK: Magic link sent successfully.

400 Bad Request: Invalid email format.

500 Internal Server Error: An error occurred while processing the request.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

client_id

string

required

This identifies the application making the request to the SSOJET server. You can find your client ID on the API Keys page in the dashboard

Example:

string

Header Params

Content-Type

string

optional

Default:

application/json

User-Agent

string

optional

Default:

SSOjet/1.0.0 (https://ssojet.com)

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

⚪0Get All Role

application/json

Body

array of:

string

required

name

string

required

slug

string

required

description

string

required

permission_id

array[string] | null

required

is_deleted

boolean

required

is_active

boolean

required

Example

[
    {
        "id": "668e7e5946b448ab754b44ac",
        "name": "Admin",
        "slug": "admin",
        "description": "Admin Role",
        "permission_id": [
            "668e7e5946b448ab754b44a8",
            "668e7e5946b448ab754b44a9",
            "668e7e5946b448ab754b44aa"
        ],
        "is_deleted": false,
        "is_active": true
    },
    {
        "id": "668e7e5a46b448ab754b44ad",
        "name": "Developer",
        "slug": "developer",
        "description": "Developer Role",
        "permission_id": [
            "668e7e5946b448ab754b44aa"
        ],
        "is_deleted": false,
        "is_active": true
    },
    {
        "id": "669237682b88a61a26a4770d",
        "name": "test",
        "slug": "test",
        "description": "test",
        "permission_id": null,
        "is_deleted": false,
        "is_active": true
    }
]

List All Roles

List All Roles#

Request

Request samples

Responses

List All Roles