Auth0 · Schema

CreateResourceServerRequestContent

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM

Properties

Name	Type	Description
name	string	Friendly name for this resource server. Can not contain `<` or `>` characters.
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).
token_lifetime	integer	Expiration value (in seconds) for access tokens issued for this API from the token endpoint.
token_dialect	object
skip_consent_for_verifiable_first_party_clients	boolean	Whether to skip user consent for applications flagged as first party (true) or not (false).
enforce_policies	boolean	Whether to enforce authorization policies (true) or to ignore them (false).
token_encryption	object
consent_policy	object
authorization_details	arraynull
proof_of_possession	object
subject_type_authorization	object
authorization_policy	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateResourceServerRequestContent",
  "title": "CreateResourceServerRequestContent",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "identifier"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Friendly name for this resource server. Can not contain `<` or `>` characters.",
      "maxLength": 200,
      "pattern": "^[^<>]+$"
    },
    "identifier": {
      "type": "string",
      "description": "Unique identifier for the API used as the audience parameter on authorization calls. Can not be changed once set.",
      "minLength": 1,
      "maxLength": 600
    },
    "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)."
    },
    "token_lifetime": {
      "type": "integer",
      "description": "Expiration value (in seconds) for access tokens issued for this API from the token endpoint.",
      "minimum": 0,
      "maximum": 2592000
    },
    "token_dialect": {
      "$ref": "#/components/schemas/ResourceServerTokenDialectSchemaEnum"
    },
    "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)."
    },
    "enforce_policies": {
      "type": "boolean",
      "description": "Whether to enforce authorization policies (true) or to ignore them (false)."
    },
    "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"
    }
  }
}