---
title: "List roles"
slug: "list-roles"
updated: 2024-11-05T13:31:41Z
published: 2024-11-05T13:31:41Z
canonical: "developers.torq.io/list-roles"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://developers.torq.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List roles

Get/v1alpha/users/roles

Returns a list of all roles that can be assigned to users in the workspace.

SecurityHTTPType bearer

Query parameterspage_sizeinteger (int32) 

The maximum number of roles to retrieve per page. Default is 50. Maximum is 100. If the number of results exceeds the defined page size, use [pagination](https://learn.torq.io/apidocs/pagination) to retrieve the next page by making an identical `List roles` request and providing the page token that was returned from the previous request.

Default50
page_tokenstring

The token received from a previous `List roles` request. Provide this to retrieve the next page of results.

Responses200

A successful response.

<select class='api-response-data' aria-label='Media type'><option value='4fc23157-655c-470b-b4c8-ee601e016cd2'>application/json</option>
</select>Expand Allobject 

List roles model

roles Array of object (v1alphaRole)   object 

Role object

idstring  (uuid)    

The unique identifier of the role.

Example74e19393-3e94-48d2-8b60-26f2d2665942
namestring    

The name of the role.

descriptionstring    

The description of the role.

scope_names Array of string   

The permissions (scopes) granted to the role.

string    

next_page_tokenstring    

When a token is returned it indicates there is another page of results to retrieve. Pass this token as the `pageToken` parameter in a subsequent `List roles` request to retrieve the next page of results. If this field isn't returned it means there are no additional pages to retrieve.

401

Invalid bearer token. If you receive this message more than once try creating a new Client ID/Client Secret or generating a new bearer token.

<select class='api-response-data' aria-label='Media type'><option value='0812b028-3b8a-4a93-9df6-adb42bab12b8'>application/json</option>
</select>object 

403

You don't have permission to access this resource.

<select class='api-response-data' aria-label='Media type'><option value='97812e94-d322-43ea-8690-5b7409eca1ae'>application/json</option>
</select>object 

default

An unexpected error response.

<select class='api-response-data' aria-label='Media type'><option value='0fe2be69-edc4-4579-ba79-b231d59a8410'>application/json</option>
</select>Expand Allobject codeinteger  (int32)    
messagestring    
details Array of object (protobufAny)   object 

`Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo))

Example 2: Pack and unpack a message in Java.

Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) // or ... if (any.isSameTypeAs(Foo.getDefaultInstance()))

Example 3: Pack and unpack a message in Python.

foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo any, err := anypb.New(foo) if err != nil ... foo := &pb.Foo if err := any.UnmarshalTo(foo); err != nil

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

# JSON

The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

package google.profile; message Person

{ "@type": "type.googleapis.com/google.profile.Person", "firstName": <string>, &quot;lastName&quot;: <string> }</string></string>

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

@typestring    

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

- If no scheme is provided, `https` is assumed.
- An HTTP GET on the URL must yield a [google.protobuf.Type][]
value in binary format, or produce an error.
- Applications are allowed to cache lookup results based on the
URL, or have them precompiled into a binary to avoid any
lookup. Therefore, binary compatibility needs to be preserved
on changes to types. (Use versioned type names to manage
breaking changes.)

Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.

Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

property*object additionalProperties