> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.itential.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itential.com/_mcp/server.

# Get a list of roles

GET http://localhost:3000/authorization/roles

Returns a list of roles.

Reference: https://docs.itential.com/itential-platform/6/api-reference/authorization/get-roles

## Authentication

- `Authorization` header (basic auth, required) — Basic authentication of the form `Basic <base64(username:password)>`.

## Request

### Query parameters

- `multiContains` (object, optional) — multiContains
  - `provenance` (string, optional)
  - `name` (string, optional)
  - `description` (string, optional)
- `multiEquals` (object, optional) — multiEquals
  - `provenance` (string, optional)
  - `name` (string, optional)
  - `description` (string, optional)
- `multiStartsWith` (object, optional) — multiStartsWith
  - `provenance` (string, optional)
  - `name` (string, optional)
  - `description` (string, optional)
- `inactive` (boolean, optional) — inactive
- `skip` (integer, optional, default: 0) — skip
- `limit` (integer, optional, default: 25) — limit
- `sort` (enum, optional, default: name) — sort
  - Allowed values: `name`
- `order` (enum, optional, default: 1) — order
  - Allowed values: `-1`, `1`

## Response

### 200

The roles matching the specified query.

- `results` (object, optional) — This is the schema for an IAP role stored in Mongo
  - `provenance` (string, required)
  - `name` (string, required)
  - `description` (string, required)
  - `allowedMethods` (list of object, required)
    - `name` (string, optional)
    - `provenance` (string, optional)
  - `allowedViews` (list of object, required)
    - `path` (string, optional)
    - `provenance` (string, optional)
  - `_meta` (object, optional)
    - `created` (string, optional)
    - `updated` (string, optional)
- `total` (integer, optional) — The total number of documents

## Errors

### 500 Internal Server Error

Error response from API

- `any`

## Examples

**Response**

```json
{
  "results": {
    "provenance": "Custom",
    "name": "role_1",
    "description": "description of role_1",
    "allowedMethods": [
      {
        "name": "methodName",
        "provenance": "ApplicationName"
      }
    ],
    "allowedViews": [
      {
        "path": "/manual/task/path",
        "provenance": "ApplicationName"
      }
    ],
    "_meta": {
      "created": "2018-08-02T15:56:12.912Z",
      "updated": "2018-08-02T15:56:12.912Z"
    }
  },
  "total": 1
}
```

**SDK Code**

```python
import requests

url = "http://localhost:3000/authorization/roles"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'http://localhost:3000/authorization/roles';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:3000/authorization/roles"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("http://localhost:3000/authorization/roles")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("http://localhost:3000/authorization/roles")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'http://localhost:3000/authorization/roles');

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("http://localhost:3000/authorization/roles");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:3000/authorization/roles")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```