List Roles

List Roles returns a list of roles supported by a provider for a particular resource type.

Path Parameters

id string required
resourceType string required

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
description string
permissions undefined[]
]

{
  "roles": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "permissions": [
        null
      ]
    }
  ]
}

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/providers/:id/resources/:resourceType/roles

Authorization

name: X-Auth-Emailtype: apiKeydescription: Email address of the userin: header

Request

Base URL

http://127.0.0.1:7400

apiKey

id — path required

resourceType — path required

curl / cURL

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/providers/:id/resources/:resourceType/roles' \
-H 'Accept: application/json' \
-H 'X-Auth-Email: <API_KEY_VALUE>'

python / requests

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/providers/:id/resources/:resourceType/roles' \
-H 'Accept: application/json' \
-H 'X-Auth-Email: <API_KEY_VALUE>'

go / native

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/providers/:id/resources/:resourceType/roles' \
-H 'Accept: application/json' \
-H 'X-Auth-Email: <API_KEY_VALUE>'

nodejs / axios

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/providers/:id/resources/:resourceType/roles' \
-H 'Accept: application/json' \
-H 'X-Auth-Email: <API_KEY_VALUE>'

ruby / Net::HTTP

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/providers/:id/resources/:resourceType/roles' \
-H 'Accept: application/json' \
-H 'X-Auth-Email: <API_KEY_VALUE>'

csharp / RestSharp

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/providers/:id/resources/:resourceType/roles' \
-H 'Accept: application/json' \
-H 'X-Auth-Email: <API_KEY_VALUE>'

php / cURL

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/providers/:id/resources/:resourceType/roles' \
-H 'Accept: application/json' \
-H 'X-Auth-Email: <API_KEY_VALUE>'

java / OkHttp

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/providers/:id/resources/:resourceType/roles' \
-H 'Accept: application/json' \
-H 'X-Auth-Email: <API_KEY_VALUE>'

powershell / RestMethod

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/providers/:id/resources/:resourceType/roles' \
-H 'Accept: application/json' \
-H 'X-Auth-Email: <API_KEY_VALUE>'