Back to Node Auth0

Interface CreateResourceServerRequestContent

docs/interfaces/management.Management.CreateResourceServerRequestContent.html

5.9.16.0 KB
Original Source

Interface CreateResourceServerRequestContent

Example

{ * identifier: "identifier" * }Copy

interface CreateResourceServerRequestContent {
name?: string;
identifier: string;
scopes?: ResourceServerScope[];
signing_alg?: Management.SigningAlgorithmEnum;
signing_secret?: string;
allow_offline_access?: boolean;
allow_online_access?: boolean;
token_lifetime?: number;
token_dialect?: Management.ResourceServerTokenDialectSchemaEnum;
skip_consent_for_verifiable_first_party_clients?: boolean;
enforce_policies?: boolean;
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;
}

Index

Properties

name?identifierscopes?signing_alg?signing_secret?allow_offline_access?allow_online_access?token_lifetime?token_dialect?skip_consent_for_verifiable_first_party_clients?enforce_policies?token_encryption?consent_policy?authorization_details?proof_of_possession?subject_type_authorization?authorization_policy?

Properties

Optionalname

name?: string

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

identifier

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

Optionaltoken_lifetime

token_lifetime?: number

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

Optionaltoken_dialect

token_dialect?: Management.ResourceServerTokenDialectSchemaEnum

skip_consent_for_verifiable_first_party_clients?: boolean

Whether to skip user consent for applications flagged as first party (true) or not (false).

Optionalenforce_policies

enforce_policies?: boolean

Whether to enforce authorization policies (true) or to ignore them (false).

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

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Properties nameidentifierscopessigning_algsigning_secretallow_offline_accessallow_online_accesstoken_lifetimetoken_dialectskip_consent_for_verifiable_first_party_clientsenforce_policiestoken_encryptionconsent_policyauthorization_detailsproof_of_possessionsubject_type_authorizationauthorization_policy