Auth0 · Schema

UpdateResourceServerResponseContent

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM

Properties

Name Type Description
id string ID of the API (resource server).
name string Friendly name for this resource server. Can not contain `<` or `>` characters.
is_system boolean Whether this is an Auth0 system API (true) or a custom API (false).
identifier string Unique identifier for the API used as the audience parameter on authorization calls. Can not be changed once set.
scopes array List of permissions (scopes) that this API uses.
signing_alg object
signing_secret string Secret used to sign tokens when using symmetric algorithms (HS256).
allow_offline_access boolean Whether refresh tokens can be issued for this API (true) or not (false).
allow_online_access boolean Whether Online Refresh Tokens can be issued for this API (true) or not (false).
skip_consent_for_verifiable_first_party_clients boolean Whether to skip user consent for applications flagged as first party (true) or not (false).
token_lifetime integer Expiration value (in seconds) for access tokens issued for this API from the token endpoint.
token_lifetime_for_web integer Expiration value (in seconds) for access tokens issued for this API via Implicit or Hybrid Flows. Cannot be greater than the `token_lifetime` value.
enforce_policies boolean Whether authorization polices are enforced (true) or unenforced (false).
token_dialect object
token_encryption object
consent_policy object
authorization_details arraynull
proof_of_possession object
subject_type_authorization object
authorization_policy object
client_id string The client ID of the client that this resource server is linked to
View JSON Schema on GitHub

JSON Schema

auth0-updateresourceserverresponsecontent-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateResourceServerResponseContent",
  "title": "UpdateResourceServerResponseContent",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the API (resource server)."
    },
    "name": {
      "type": "string",
      "description": "Friendly name for this resource server. Can not contain `<` or `>` characters."
    },
    "is_system": {
      "type": "boolean",
      "description": "Whether this is an Auth0 system API (true) or a custom API (false)."
    },
    "identifier": {
      "type": "string",
      "description": "Unique identifier for the API used as the audience parameter on authorization calls. Can not be changed once set."
    },
    "scopes": {
      "type": "array",
      "description": "List of permissions (scopes) that this API uses.",
      "items": {
        "$ref": "#/components/schemas/ResourceServerScope"
      }
    },
    "signing_alg": {
      "$ref": "#/components/schemas/SigningAlgorithmEnum"
    },
    "signing_secret": {
      "type": "string",
      "description": "Secret used to sign tokens when using symmetric algorithms (HS256).",
      "minLength": 16
    },
    "allow_offline_access": {
      "type": "boolean",
      "description": "Whether refresh tokens can be issued for this API (true) or not (false)."
    },
    "allow_online_access": {
      "type": "boolean",
      "description": "Whether Online Refresh Tokens can be issued for this API (true) or not (false)."
    },
    "skip_consent_for_verifiable_first_party_clients": {
      "type": "boolean",
      "description": "Whether to skip user consent for applications flagged as first party (true) or not (false)."
    },
    "token_lifetime": {
      "type": "integer",
      "description": "Expiration value (in seconds) for access tokens issued for this API from the token endpoint."
    },
    "token_lifetime_for_web": {
      "type": "integer",
      "description": "Expiration value (in seconds) for access tokens issued for this API via Implicit or Hybrid Flows. Cannot be greater than the `token_lifetime` value."
    },
    "enforce_policies": {
      "type": "boolean",
      "description": "Whether authorization polices are enforced (true) or unenforced (false)."
    },
    "token_dialect": {
      "$ref": "#/components/schemas/ResourceServerTokenDialectResponseEnum"
    },
    "token_encryption": {
      "$ref": "#/components/schemas/ResourceServerTokenEncryption"
    },
    "consent_policy": {
      "$ref": "#/components/schemas/ResourceServerConsentPolicyEnum"
    },
    "authorization_details": {
      "type": [
        "array",
        "null"
      ],
      "items": {}
    },
    "proof_of_possession": {
      "$ref": "#/components/schemas/ResourceServerProofOfPossession"
    },
    "subject_type_authorization": {
      "$ref": "#/components/schemas/ResourceServerSubjectTypeAuthorization"
    },
    "authorization_policy": {
      "$ref": "#/components/schemas/ResourceServerAuthorizationPolicy",
      "x-release-lifecycle": "EA"
    },
    "client_id": {
      "type": "string",
      "description": "The client ID of the client that this resource server is linked to",
      "format": "client-id"
    }
  }
}