Auth0 API | Resource Servers › Get Resource Servers

Resource Servers

resource_servers

Methods

Create A Resource Server -> { id, allow_offline_access, authorization_details, 15 more... }

post/resource-servers

Create a new API associated with your tenant. Note that all new APIs must be registered with Auth0. For more information, read APIs.

Delete A Resource Server ->

delete/resource-servers/{id}

Delete an existing API by ID. For more information, read API Settings.

Get Resource Servers -> ResourceServersPageNumberPage<{ id, allow_offline_access, authorization_details, 15 more... }>

get/resource-servers

Retrieve details of all APIs associated with your tenant.

Security

Example: Authorization: Bearer My Bearer Token

Parameters

identifiers: Array<string>

Optional

An optional filter on the resource server identifier. Must be URL encoded and may be specified multiple times (max 10).
e.g. ../resource-servers?identifiers=id1&identifiers=id2

include_fields: boolean

Optional

Whether specified fields are to be included (true) or excluded (false).

include_totals: boolean

Optional

Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).

page: number

Optional

(minimum: 0)

Page index of the results to return. First page is 0.

per_page: number

Optional

(maximum: 100, minimum: 1)

Number of results per page.

Response fields

UnionMember0 = Array<{ id, allow_offline_access, authorization_details, 15 more... }>

UnionMember1 = { limit, resource_servers, start, 1 more... }

Request example

curl https://login0.local.dev.auth0.com/api/v2/resource-servers \
    -H "Authorization: Bearer $BEARER_TOKEN"

200Example

[
  {
    "id": "id",
    "allow_offline_access": true,
    "authorization_details": [
      {}
    ],
    "client": {},
    "consent_policy": "transactional-authorization-with-mfa",
    "enforce_policies": true,
    "identifier": "identifier",
    "is_system": true,
    "name": "name",
    "proof_of_possession": {
      "mechanism": "mtls",
      "required": true
    },
    "scopes": [
      {
        "value": "x",
        "description": "description"
      }
    ],
    "signing_alg": "HS256",
    "signing_secret": "xxxxxxxxxxxxxxxx",
    "skip_consent_for_verifiable_first_party_clients": true,
    "token_dialect": "access_token",
    "token_encryption": {
      "encryption_key": {
        "alg": "RSA-OAEP-256",
        "pem": "x",
        "kid": "x",
        "name": "x"
      },
      "format": "compact-nested-jwe"
    },
    "token_lifetime": 0,
    "token_lifetime_for_web": 0
  }
]

Get A Resource Server -> { id, allow_offline_access, authorization_details, 15 more... }

get/resource-servers/{id}

Retrieve API details with the given ID.

Update A Resource Server -> { id, allow_offline_access, authorization_details, 15 more... }

patch/resource-servers/{id}

Change an existing API setting by resource server ID. For more information, read API Settings.