get Roles

GET 
/roles

This operation allows to get all Role

Request

Query Parameters

limit int32

Limit of the page

offset int32

Offset of the page

Responses

200

ok

Response Headers

• X-Total-Count

  integer

  total count of roles

• X-Result-Count

  integer

  roles result count

application/json

Schema

Schema

• Array [

id uuid

Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

role uuid

name string

role name

permissions

object[]

list of permissions associated to a role

Array [

id uuid

Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

permission uuid

name string

permission name

]

• ]

Example (from schema)

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "permissions": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string"
      }
    ]
  }
]

401

unauthorized access

application/json

Schema

Schema

code int32

error code

message string

error message

description string

error description

Example (from schema)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

403

forbidden access

application/json

Schema

Schema

code int32

error code

message string

error message

description string

error description

Example (from schema)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

500

internal error

application/json

Schema

Schema

code int32

error code

message string

error message

description string

error description

Example (from schema)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

Loading...