Back to Node Auth0

Interface GetResourceServerResponseContent

docs/interfaces/management.Management.GetResourceServerResponseContent.html

5.9.16.8 KB
Original Source

Interface GetResourceServerResponseContent

interface GetResourceServerResponseContent {
id?: string;
name?: string;
is_system?: boolean;
identifier?: string;
scopes?: ResourceServerScope[];
signing_alg?: Management.SigningAlgorithmEnum;
signing_secret?: string;
allow_offline_access?: boolean;
allow_online_access?: boolean;
skip_consent_for_verifiable_first_party_clients?: boolean;
token_lifetime?: number;
token_lifetime_for_web?: number;
enforce_policies?: boolean;
token_dialect?: Management.ResourceServerTokenDialectResponseEnum;
token_encryption?: ResourceServerTokenEncryption | null;
consent_policy?: "transactional-authorization-with-mfa" | null;
authorization_details?: unknown[] | null;
proof_of_possession?: ResourceServerProofOfPossession | null;
subject_type_authorization?: ResourceServerSubjectTypeAuthorization;
authorization_policy?: ResourceServerAuthorizationPolicy | null;
client_id?: string;
}

Index

Properties

id?name?is_system?identifier?scopes?signing_alg?signing_secret?allow_offline_access?allow_online_access?skip_consent_for_verifiable_first_party_clients?token_lifetime?token_lifetime_for_web?enforce_policies?token_dialect?token_encryption?consent_policy?authorization_details?proof_of_possession?subject_type_authorization?authorization_policy?client_id?

Properties

Optionalid

id?: string

ID of the API (resource server).

Optionalname

name?: string

Friendly name for this resource server. Can not contain < or > characters.

Optionalis_system

is_system?: boolean

Whether this is an Auth0 system API (true) or a custom API (false).

Optionalidentifier

identifier?: string

Unique identifier for the API used as the audience parameter on authorization calls. Can not be changed once set.

Optionalscopes

scopes?: ResourceServerScope[]

List of permissions (scopes) that this API uses.

Optionalsigning_alg

signing_alg?: Management.SigningAlgorithmEnum

Optionalsigning_secret

signing_secret?: string

Secret used to sign tokens when using symmetric algorithms (HS256).

Optionalallow_offline_access

allow_offline_access?: boolean

Whether refresh tokens can be issued for this API (true) or not (false).

Optionalallow_online_access

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).

Optionaltoken_lifetime

token_lifetime?: number

Expiration value (in seconds) for access tokens issued for this API from the token endpoint.

Optionaltoken_lifetime_for_web

token_lifetime_for_web?: number

Expiration value (in seconds) for access tokens issued for this API via Implicit or Hybrid Flows. Cannot be greater than the token_lifetime value.

Optionalenforce_policies

enforce_policies?: boolean

Whether authorization polices are enforced (true) or unenforced (false).

Optionaltoken_dialect

token_dialect?: Management.ResourceServerTokenDialectResponseEnum

Optionaltoken_encryption

token_encryption?: ResourceServerTokenEncryption | null

Optionalconsent_policy

consent_policy?: "transactional-authorization-with-mfa" | null

Optionalauthorization_details

authorization_details?: unknown[] | null

Optionalproof_of_possession

proof_of_possession?: ResourceServerProofOfPossession | null

Optionalsubject_type_authorization

subject_type_authorization?: ResourceServerSubjectTypeAuthorization

Optionalauthorization_policy

authorization_policy?: ResourceServerAuthorizationPolicy | null

Optionalclient_id

client_id?: string

The client ID of the client that this resource server is linked to

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Properties idnameis_systemidentifierscopessigning_algsigning_secretallow_offline_accessallow_online_accessskip_consent_for_verifiable_first_party_clientstoken_lifetimetoken_lifetime_for_webenforce_policiestoken_dialecttoken_encryptionconsent_policyauthorization_detailsproof_of_possessionsubject_type_authorizationauthorization_policyclient_id