Get all Roles available in mk

ApiScope: manage.role.read
API Scope Level: ServiceSubscriberScope

Responses

• 200
• 400
• 401
• 403
• 500

---

OK

application/json

application/x-protobuf

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string
roles object[]
Array [
uuid string
roleName string
roleAcronym string
isMyKaarmaAdmin boolean
isVirtual boolean
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string",
  "roles": [
    {
      "uuid": "string",
      "roleName": "string",
      "roleAcronym": "string",
      "isMyKaarmaAdmin": true,
      "isVirtual": true
    }
  ]
}

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string
roles object[]
Array [
uuid string
roleName string
roleAcronym string
isMyKaarmaAdmin boolean
isVirtual boolean
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string",
  "roles": [
    {
      "uuid": "string",
      "roleName": "string",
      "roleAcronym": "string",
      "isMyKaarmaAdmin": true,
      "isVirtual": true
    }
  ]
}

Bad Request

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Unauthorized

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Forbidden

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Internal Server Error

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

POST /v2/role/list

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/manage

Username

Password

Accept

application/jsonapplication/x-protobuf

curl / cURL

curl -L -X POST '/manage/v2/role/list' \
-H 'Accept: application/json'

python / requests

curl -L -X POST '/manage/v2/role/list' \
-H 'Accept: application/json'

go / native

curl -L -X POST '/manage/v2/role/list' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X POST '/manage/v2/role/list' \
-H 'Accept: application/json'

ruby / Net::HTTP

curl -L -X POST '/manage/v2/role/list' \
-H 'Accept: application/json'

csharp / RestSharp

curl -L -X POST '/manage/v2/role/list' \
-H 'Accept: application/json'

php / cURL

curl -L -X POST '/manage/v2/role/list' \
-H 'Accept: application/json'

java / OkHttp

curl -L -X POST '/manage/v2/role/list' \
-H 'Accept: application/json'

powershell / RestMethod

curl -L -X POST '/manage/v2/role/list' \
-H 'Accept: application/json'