---
title: "List Resource Servers For a Realm"
method: GET
path: "/v1/tenants/{tenant_id}/realms/{realm_id}/resource-servers"
tags: ["Resource Servers"]
---

# List Resource Servers For a Realm

`GET /v1/tenants/{tenant_id}/realms/{realm_id}/resource-servers`

## Request

- Base URL: `https://api-us.beyondidentity.com`
- URL: `https://api-us.beyondidentity.com/v1/tenants/{tenant_id}/realms/{realm_id}/resource-servers`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-access-api/docs/v1/tenants/:tenant_id/realms/:realm_id/resource-servers/get.ts> (a function with typed inputs; its response is checked against the schema)

To list all resource servers for a realm, send a GET request to
`/v1/tenants/$TENANT_ID/realms/$REALM_ID/resource-servers`.

The response will contain at most 100 items and may contain a page token to
query the remaining items. If page size is not specified, the response will
contain 100 items. There is no defined ordering of the list of resource
servers in the response.  Note that the maximum and default page sizes are
subject to change.

When paginating, the page size is maintained by the page token but may be
overridden on subsequent requests. The skip is not maintained by the page
token and must be specified on each subsequent request.

Page tokens expire after one week. Requests which specify an expired page
token will result in undefined behavior.

## Path parameters

- `tenant_id` string, required
- `realm_id` string, required

## Query parameters

- `page_size` integer
- `page_token` string

## Response `200`

The response will be a JSON object with a keys for `resource_servers` and `total_size`. `resource_servers` will be set to an array of resource server objects, each of which contains the standard resource server attributes. `total_size` will be set to the total number of items matched by the list request. If there are more items to be returned by the requested query, the response will also contain a key called `next_page_token`.

- ListResourceServersResponse: Response for ListResourceServers.
  - `resource_servers` ResourceServer[], required: An unordered array of resource servers corresponding to the request.
    - `id` string: A unique identifier for a resource server. This is automatically generated on creation. This field is immutable and read-only. This field is unique within the realm.
    - `realm_id` string: A unique identifier for the resource server's realm. This is automatically set on creation. This field is immutable and read-only.
    - `tenant_id` string: A unique identifier for the resource server's tenant. This is automatically set on creation. This field is immutable and read-only.
    - `display_name` string: A human-readable name for the resource server. This name is used for display purposes.
    - `is_managed` boolean: A boolean indicating whether the resource server is managed by Beyond Identity. Managed resource servers may not be modified by the user. This is automatically set on creation. This field is immutable and read-only.
    - `identifier` string: The identifier of this resource server entity. This value should be unique per realm and is often presented as a URI, as it should be a unique identifier for an API to which access is being gated. This identifier will be returned in the `audience` claim of all tokens minted that provide access to scopes owned by this resource server. The client is responsible for validating tokens are intended for them via this `audience` claim. Tokens minted for the Beyond Identity Management API will use the audience `beyondidentity`, which is reserved and may not be used for any other resource servers.
    - `scopes` string[]: The list of scopes supported by this resource server. For the Beyond Identity Management API, this will include scopes for all publicly available endpoints. Note that applications may not provide access to scopes that are not defined on a resource server that they reference; this is the superset of all allowable application scopes in a given realm.
  - `total_size` integer, required: Total number of results returned by the operation. This value may be larger than the number of resources returned, such as when returning a single page where multiple pages are available.
  - `next_page_token` string: Token used to fetch the next set of results. If this field is omitted, there are no subsequent pages.

## Other responses

- `400`: Bad request.
- `401`: Unauthorized.
- `403`: Forbidden.
- `404`: The resource was not found.
- `500`: Server error.

---

[API](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-access-api.md) - [All operations](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-access-api/llms.txt) - [OpenAPI document](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-access-api/revisions/42f3cac49392?raw)