List platform roles

Returns a list of platform wide roles available in enitre Frontier instance along with their associated permissions

Query Parameters

state string
scopes string[]

Responses

• 200
• 400
• 401
• 403
• 404
• 500
• default

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

roles object[]
Array [
id string
name string
permissions string[]
title string
metadata object
created_at date-time
The time the role was created.
updated_at date-time
The time the role was last updated.
org_id string
state string
scopes string[]
]

{
  "roles": [
    {
      "id": "string",
      "name": "string",
      "permissions": [
        "string"
      ],
      "title": "string",
      "metadata": {},
      "created_at": "2023-06-07T05:39:56.961Z",
      "updated_at": "2023-06-07T05:39:56.961Z",
      "org_id": "string",
      "state": "string",
      "scopes": [
        "string"
      ]
    }
  ]
}

Bad Request - The request was malformed or contained invalid parameters.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Unauthorized - Authentication is required

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Forbidden - User does not have permission to access the resource

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Not Found - The requested resource was not found

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Internal Server Error. Returned when theres is something wrong with Frontier server.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

GET /v1beta1/roles

Authorization

name: Basic type: httpdescription: use Client ID as username and Client Secret as passwordin: headerscheme: basic

Request

Base URL

http://127.0.0.1:7400

Security Scheme

BasicBearer

Username

Password

state — query

scopes — query

curl / cURL

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/roles' \
-H 'Accept: application/json'

python / requests

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/roles' \
-H 'Accept: application/json'

go / native

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/roles' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/roles' \
-H 'Accept: application/json'

ruby / Net::HTTP

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/roles' \
-H 'Accept: application/json'

csharp / RestSharp

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/roles' \
-H 'Accept: application/json'

php / cURL

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/roles' \
-H 'Accept: application/json'

java / OkHttp

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/roles' \
-H 'Accept: application/json'

powershell / RestMethod

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/roles' \
-H 'Accept: application/json'