Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Auth0 Provider
  3. API Docs
  4. ResourceServer
Auth0 v3.7.1 published on Thursday, Sep 12, 2024 by Pulumi
pulumi/pulumi-auth0

auth0.ResourceServer

Explore with Pulumi AI

auth0 logo
Auth0 v3.7.1 published on Thursday, Sep 12, 2024 by Pulumi
pulumi/pulumi-auth0

    With this resource, you can set up APIs that can be consumed from your authorized applications.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as auth0 from "@pulumi/auth0";

const myResourceServer = new auth0.ResourceServer("my_resource_server", {
    name: "Example Resource Server (Managed by Terraform)",
    identifier: "https://api.example.com",
    signingAlg: "RS256",
    allowOfflineAccess: true,
    tokenLifetime: 8600,
    skipConsentForVerifiableFirstPartyClients: true,
});

    import pulumi
import pulumi_auth0 as auth0

my_resource_server = auth0.ResourceServer("my_resource_server",
    name="Example Resource Server (Managed by Terraform)",
    identifier="https://api.example.com",
    signing_alg="RS256",
    allow_offline_access=True,
    token_lifetime=8600,
    skip_consent_for_verifiable_first_party_clients=True)

    package main

import (
	"github.com/pulumi/pulumi-auth0/sdk/v3/go/auth0"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := auth0.NewResourceServer(ctx, "my_resource_server", &auth0.ResourceServerArgs{
			Name:               pulumi.String("Example Resource Server (Managed by Terraform)"),
			Identifier:         pulumi.String("https://api.example.com"),
			SigningAlg:         pulumi.String("RS256"),
			AllowOfflineAccess: pulumi.Bool(true),
			TokenLifetime:      pulumi.Int(8600),
			SkipConsentForVerifiableFirstPartyClients: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Auth0 = Pulumi.Auth0;

return await Deployment.RunAsync(() => 
{
    var myResourceServer = new Auth0.ResourceServer("my_resource_server", new()
    {
        Name = "Example Resource Server (Managed by Terraform)",
        Identifier = "https://api.example.com",
        SigningAlg = "RS256",
        AllowOfflineAccess = true,
        TokenLifetime = 8600,
        SkipConsentForVerifiableFirstPartyClients = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.auth0.ResourceServer;
import com.pulumi.auth0.ResourceServerArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var myResourceServer = new ResourceServer("myResourceServer", ResourceServerArgs.builder()
            .name("Example Resource Server (Managed by Terraform)")
            .identifier("https://api.example.com")
            .signingAlg("RS256")
            .allowOfflineAccess(true)
            .tokenLifetime(8600)
            .skipConsentForVerifiableFirstPartyClients(true)
            .build());

    }
}

    resources:
  myResourceServer:
    type: auth0:ResourceServer
    name: my_resource_server
    properties:
      name: Example Resource Server (Managed by Terraform)
      identifier: https://api.example.com
      signingAlg: RS256
      allowOfflineAccess: true
      tokenLifetime: 8600
      skipConsentForVerifiableFirstPartyClients: true

    Create ResourceServer Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ResourceServer(name: string, args: ResourceServerArgs, opts?: CustomResourceOptions);
    @overload
def ResourceServer(resource_name: str,
                   args: ResourceServerArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def ResourceServer(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   identifier: Optional[str] = None,
                   allow_offline_access: Optional[bool] = None,
                   enforce_policies: Optional[bool] = None,
                   name: Optional[str] = None,
                   signing_alg: Optional[str] = None,
                   signing_secret: Optional[str] = None,
                   skip_consent_for_verifiable_first_party_clients: Optional[bool] = None,
                   token_dialect: Optional[str] = None,
                   token_lifetime: Optional[int] = None,
                   token_lifetime_for_web: Optional[int] = None,
                   verification_location: Optional[str] = None)
    func NewResourceServer(ctx *Context, name string, args ResourceServerArgs, opts ...ResourceOption) (*ResourceServer, error)
    public ResourceServer(string name, ResourceServerArgs args, CustomResourceOptions? opts = null)
    public ResourceServer(String name, ResourceServerArgs args)
public ResourceServer(String name, ResourceServerArgs args, CustomResourceOptions options)

    type: auth0:ResourceServer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ResourceServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ResourceServerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ResourceServerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ResourceServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ResourceServerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var resourceServerResource = new Auth0.ResourceServer("resourceServerResource", new()
{
    Identifier = "string",
    AllowOfflineAccess = false,
    EnforcePolicies = false,
    Name = "string",
    SigningAlg = "string",
    SigningSecret = "string",
    SkipConsentForVerifiableFirstPartyClients = false,
    TokenDialect = "string",
    TokenLifetime = 0,
    TokenLifetimeForWeb = 0,
    VerificationLocation = "string",
});

    example, err := auth0.NewResourceServer(ctx, "resourceServerResource", &auth0.ResourceServerArgs{
	Identifier:         pulumi.String("string"),
	AllowOfflineAccess: pulumi.Bool(false),
	EnforcePolicies:    pulumi.Bool(false),
	Name:               pulumi.String("string"),
	SigningAlg:         pulumi.String("string"),
	SigningSecret:      pulumi.String("string"),
	SkipConsentForVerifiableFirstPartyClients: pulumi.Bool(false),
	TokenDialect:         pulumi.String("string"),
	TokenLifetime:        pulumi.Int(0),
	TokenLifetimeForWeb:  pulumi.Int(0),
	VerificationLocation: pulumi.String("string"),
})

    var resourceServerResource = new ResourceServer("resourceServerResource", ResourceServerArgs.builder()
    .identifier("string")
    .allowOfflineAccess(false)
    .enforcePolicies(false)
    .name("string")
    .signingAlg("string")
    .signingSecret("string")
    .skipConsentForVerifiableFirstPartyClients(false)
    .tokenDialect("string")
    .tokenLifetime(0)
    .tokenLifetimeForWeb(0)
    .verificationLocation("string")
    .build());

    resource_server_resource = auth0.ResourceServer("resourceServerResource",
    identifier="string",
    allow_offline_access=False,
    enforce_policies=False,
    name="string",
    signing_alg="string",
    signing_secret="string",
    skip_consent_for_verifiable_first_party_clients=False,
    token_dialect="string",
    token_lifetime=0,
    token_lifetime_for_web=0,
    verification_location="string")

    const resourceServerResource = new auth0.ResourceServer("resourceServerResource", {
    identifier: "string",
    allowOfflineAccess: false,
    enforcePolicies: false,
    name: "string",
    signingAlg: "string",
    signingSecret: "string",
    skipConsentForVerifiableFirstPartyClients: false,
    tokenDialect: "string",
    tokenLifetime: 0,
    tokenLifetimeForWeb: 0,
    verificationLocation: "string",
});

    type: auth0:ResourceServer
properties:
    allowOfflineAccess: false
    enforcePolicies: false
    identifier: string
    name: string
    signingAlg: string
    signingSecret: string
    skipConsentForVerifiableFirstPartyClients: false
    tokenDialect: string
    tokenLifetime: 0
    tokenLifetimeForWeb: 0
    verificationLocation: string

    ResourceServer Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ResourceServer resource accepts the following input properties:

    Identifier string
    Unique identifier for the resource server. Used as the audience parameter for authorization calls. Cannot be changed once set.
    AllowOfflineAccess bool
    Indicates whether refresh tokens can be issued for this resource server.
    EnforcePolicies bool
    If this setting is enabled, RBAC authorization policies will be enforced for this API. Role and permission assignments will be evaluated during the login transaction.
    Name string
    Friendly name for the resource server. Cannot include < or > characters.
    SigningAlg string
    Algorithm used to sign JWTs. Options include HS256 and RS256.
    SigningSecret string
    Secret used to sign tokens when using symmetric algorithms (HS256).
    SkipConsentForVerifiableFirstPartyClients bool
    Indicates whether to skip user consent for applications flagged as first party.
    TokenDialect string
    Dialect of access tokens that should be issued for this resource server. Options include access_token, rfc9068_profile, access_token_authz, and rfc9068_profile_authz. access_token is a JWT containing standard Auth0 claims. rfc9068_profile is a JWT conforming to the IETF JWT Access Token Profile. access_token_authz is a JWT containing standard Auth0 claims, including RBAC permissions claims. rfc9068_profile_authz is a JWT conforming to the IETF JWT Access Token Profile, including RBAC permissions claims. RBAC permissions claims are available if RBAC (enforce_policies) is enabled for this API. For more details, refer to Access Token Profiles.
    TokenLifetime int
    Number of seconds during which access tokens issued for this resource server from the token endpoint remain valid.
    TokenLifetimeForWeb int
    Number of seconds during which access tokens issued for this resource server via implicit or hybrid flows remain valid. Cannot be greater than the token_lifetime value.
    VerificationLocation string
    URL from which to retrieve JWKs for this resource server. Used for verifying the JWT sent to Auth0 for token introspection.
    Identifier string
    Unique identifier for the resource server. Used as the audience parameter for authorization calls. Cannot be changed once set.
    AllowOfflineAccess bool
    Indicates whether refresh tokens can be issued for this resource server.
    EnforcePolicies bool
    If this setting is enabled, RBAC authorization policies will be enforced for this API. Role and permission assignments will be evaluated during the login transaction.
    Name string
    Friendly name for the resource server. Cannot include < or > characters.
    SigningAlg string
    Algorithm used to sign JWTs. Options include HS256 and RS256.
    SigningSecret string
    Secret used to sign tokens when using symmetric algorithms (HS256).
    SkipConsentForVerifiableFirstPartyClients bool
    Indicates whether to skip user consent for applications flagged as first party.
    TokenDialect string
    Dialect of access tokens that should be issued for this resource server. Options include access_token, rfc9068_profile, access_token_authz, and rfc9068_profile_authz. access_token is a JWT containing standard Auth0 claims. rfc9068_profile is a JWT conforming to the IETF JWT Access Token Profile. access_token_authz is a JWT containing standard Auth0 claims, including RBAC permissions claims. rfc9068_profile_authz is a JWT conforming to the IETF JWT Access Token Profile, including RBAC permissions claims. RBAC permissions claims are available if RBAC (enforce_policies) is enabled for this API. For more details, refer to Access Token Profiles.
    TokenLifetime int
    Number of seconds during which access tokens issued for this resource server from the token endpoint remain valid.
    TokenLifetimeForWeb int
    Number of seconds during which access tokens issued for this resource server via implicit or hybrid flows remain valid. Cannot be greater than the token_lifetime value.
    VerificationLocation string
    URL from which to retrieve JWKs for this resource server. Used for verifying the JWT sent to Auth0 for token introspection.
    identifier String
    Unique identifier for the resource server. Used as the audience parameter for authorization calls. Cannot be changed once set.
    allowOfflineAccess Boolean
    Indicates whether refresh tokens can be issued for this resource server.
    enforcePolicies Boolean
    If this setting is enabled, RBAC authorization policies will be enforced for this API. Role and permission assignments will be evaluated during the login transaction.
    name String
    Friendly name for the resource server. Cannot include < or > characters.
    signingAlg String
    Algorithm used to sign JWTs. Options include HS256 and RS256.
    signingSecret String
    Secret used to sign tokens when using symmetric algorithms (HS256).
    skipConsentForVerifiableFirstPartyClients Boolean
    Indicates whether to skip user consent for applications flagged as first party.
    tokenDialect String
    Dialect of access tokens that should be issued for this resource server. Options include access_token, rfc9068_profile, access_token_authz, and rfc9068_profile_authz. access_token is a JWT containing standard Auth0 claims. rfc9068_profile is a JWT conforming to the IETF JWT Access Token Profile. access_token_authz is a JWT containing standard Auth0 claims, including RBAC permissions claims. rfc9068_profile_authz is a JWT conforming to the IETF JWT Access Token Profile, including RBAC permissions claims. RBAC permissions claims are available if RBAC (enforce_policies) is enabled for this API. For more details, refer to Access Token Profiles.
    tokenLifetime Integer
    Number of seconds during which access tokens issued for this resource server from the token endpoint remain valid.
    tokenLifetimeForWeb Integer
    Number of seconds during which access tokens issued for this resource server via implicit or hybrid flows remain valid. Cannot be greater than the token_lifetime value.
    verificationLocation String
    URL from which to retrieve JWKs for this resource server. Used for verifying the JWT sent to Auth0 for token introspection.
    identifier string
    Unique identifier for the resource server. Used as the audience parameter for authorization calls. Cannot be changed once set.
    allowOfflineAccess boolean
    Indicates whether refresh tokens can be issued for this resource server.
    enforcePolicies boolean
    If this setting is enabled, RBAC authorization policies will be enforced for this API. Role and permission assignments will be evaluated during the login transaction.
    name string
    Friendly name for the resource server. Cannot include < or > characters.
    signingAlg string
    Algorithm used to sign JWTs. Options include HS256 and RS256.
    signingSecret string
    Secret used to sign tokens when using symmetric algorithms (HS256).
    skipConsentForVerifiableFirstPartyClients boolean
    Indicates whether to skip user consent for applications flagged as first party.
    tokenDialect string
    Dialect of access tokens that should be issued for this resource server. Options include access_token, rfc9068_profile, access_token_authz, and rfc9068_profile_authz. access_token is a JWT containing standard Auth0 claims. rfc9068_profile is a JWT conforming to the IETF JWT Access Token Profile. access_token_authz is a JWT containing standard Auth0 claims, including RBAC permissions claims. rfc9068_profile_authz is a JWT conforming to the IETF JWT Access Token Profile, including RBAC permissions claims. RBAC permissions claims are available if RBAC (enforce_policies) is enabled for this API. For more details, refer to Access Token Profiles.
    tokenLifetime number
    Number of seconds during which access tokens issued for this resource server from the token endpoint remain valid.
    tokenLifetimeForWeb number
    Number of seconds during which access tokens issued for this resource server via implicit or hybrid flows remain valid. Cannot be greater than the token_lifetime value.
    verificationLocation string
    URL from which to retrieve JWKs for this resource server. Used for verifying the JWT sent to Auth0 for token introspection.
    identifier str
    Unique identifier for the resource server. Used as the audience parameter for authorization calls. Cannot be changed once set.
    allow_offline_access bool
    Indicates whether refresh tokens can be issued for this resource server.
    enforce_policies bool
    If this setting is enabled, RBAC authorization policies will be enforced for this API. Role and permission assignments will be evaluated during the login transaction.
    name str
    Friendly name for the resource server. Cannot include < or > characters.
    signing_alg str
    Algorithm used to sign JWTs. Options include HS256 and RS256.
    signing_secret str
    Secret used to sign tokens when using symmetric algorithms (HS256).
    skip_consent_for_verifiable_first_party_clients bool
    Indicates whether to skip user consent for applications flagged as first party.
    token_dialect str
    Dialect of access tokens that should be issued for this resource server. Options include access_token, rfc9068_profile, access_token_authz, and rfc9068_profile_authz. access_token is a JWT containing standard Auth0 claims. rfc9068_profile is a JWT conforming to the IETF JWT Access Token Profile. access_token_authz is a JWT containing standard Auth0 claims, including RBAC permissions claims. rfc9068_profile_authz is a JWT conforming to the IETF JWT Access Token Profile, including RBAC permissions claims. RBAC permissions claims are available if RBAC (enforce_policies) is enabled for this API. For more details, refer to Access Token Profiles.
    token_lifetime int
    Number of seconds during which access tokens issued for this resource server from the token endpoint remain valid.
    token_lifetime_for_web int
    Number of seconds during which access tokens issued for this resource server via implicit or hybrid flows remain valid. Cannot be greater than the token_lifetime value.
    verification_location str
    URL from which to retrieve JWKs for this resource server. Used for verifying the JWT sent to Auth0 for token introspection.
    identifier String
    Unique identifier for the resource server. Used as the audience parameter for authorization calls. Cannot be changed once set.
    allowOfflineAccess Boolean
    Indicates whether refresh tokens can be issued for this resource server.
    enforcePolicies Boolean
    If this setting is enabled, RBAC authorization policies will be enforced for this API. Role and permission assignments will be evaluated during the login transaction.
    name String
    Friendly name for the resource server. Cannot include < or > characters.
    signingAlg String
    Algorithm used to sign JWTs. Options include HS256 and RS256.
    signingSecret String
    Secret used to sign tokens when using symmetric algorithms (HS256).
    skipConsentForVerifiableFirstPartyClients Boolean
    Indicates whether to skip user consent for applications flagged as first party.
    tokenDialect String
    Dialect of access tokens that should be issued for this resource server. Options include access_token, rfc9068_profile, access_token_authz, and rfc9068_profile_authz. access_token is a JWT containing standard Auth0 claims. rfc9068_profile is a JWT conforming to the IETF JWT Access Token Profile. access_token_authz is a JWT containing standard Auth0 claims, including RBAC permissions claims. rfc9068_profile_authz is a JWT conforming to the IETF JWT Access Token Profile, including RBAC permissions claims. RBAC permissions claims are available if RBAC (enforce_policies) is enabled for this API. For more details, refer to Access Token Profiles.
    tokenLifetime Number
    Number of seconds during which access tokens issued for this resource server from the token endpoint remain valid.
    tokenLifetimeForWeb Number
    Number of seconds during which access tokens issued for this resource server via implicit or hybrid flows remain valid. Cannot be greater than the token_lifetime value.
    verificationLocation String
    URL from which to retrieve JWKs for this resource server. Used for verifying the JWT sent to Auth0 for token introspection.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ResourceServer resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ResourceServer Resource

    Get an existing ResourceServer resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ResourceServerState, opts?: CustomResourceOptions): ResourceServer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_offline_access: Optional[bool] = None,
        enforce_policies: Optional[bool] = None,
        identifier: Optional[str] = None,
        name: Optional[str] = None,
        signing_alg: Optional[str] = None,
        signing_secret: Optional[str] = None,
        skip_consent_for_verifiable_first_party_clients: Optional[bool] = None,
        token_dialect: Optional[str] = None,
        token_lifetime: Optional[int] = None,
        token_lifetime_for_web: Optional[int] = None,
        verification_location: Optional[str] = None) -> ResourceServer
    func GetResourceServer(ctx *Context, name string, id IDInput, state *ResourceServerState, opts ...ResourceOption) (*ResourceServer, error)
    public static ResourceServer Get(string name, Input<string> id, ResourceServerState? state, CustomResourceOptions? opts = null)
    public static ResourceServer get(String name, Output<String> id, ResourceServerState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AllowOfflineAccess bool
    Indicates whether refresh tokens can be issued for this resource server.
    EnforcePolicies bool
    If this setting is enabled, RBAC authorization policies will be enforced for this API. Role and permission assignments will be evaluated during the login transaction.
    Identifier string
    Unique identifier for the resource server. Used as the audience parameter for authorization calls. Cannot be changed once set.
    Name string
    Friendly name for the resource server. Cannot include < or > characters.
    SigningAlg string
    Algorithm used to sign JWTs. Options include HS256 and RS256.
    SigningSecret string
    Secret used to sign tokens when using symmetric algorithms (HS256).
    SkipConsentForVerifiableFirstPartyClients bool
    Indicates whether to skip user consent for applications flagged as first party.
    TokenDialect string
    Dialect of access tokens that should be issued for this resource server. Options include access_token, rfc9068_profile, access_token_authz, and rfc9068_profile_authz. access_token is a JWT containing standard Auth0 claims. rfc9068_profile is a JWT conforming to the IETF JWT Access Token Profile. access_token_authz is a JWT containing standard Auth0 claims, including RBAC permissions claims. rfc9068_profile_authz is a JWT conforming to the IETF JWT Access Token Profile, including RBAC permissions claims. RBAC permissions claims are available if RBAC (enforce_policies) is enabled for this API. For more details, refer to Access Token Profiles.
    TokenLifetime int
    Number of seconds during which access tokens issued for this resource server from the token endpoint remain valid.
    TokenLifetimeForWeb int
    Number of seconds during which access tokens issued for this resource server via implicit or hybrid flows remain valid. Cannot be greater than the token_lifetime value.
    VerificationLocation string
    URL from which to retrieve JWKs for this resource server. Used for verifying the JWT sent to Auth0 for token introspection.
    AllowOfflineAccess bool
    Indicates whether refresh tokens can be issued for this resource server.
    EnforcePolicies bool
    If this setting is enabled, RBAC authorization policies will be enforced for this API. Role and permission assignments will be evaluated during the login transaction.
    Identifier string
    Unique identifier for the resource server. Used as the audience parameter for authorization calls. Cannot be changed once set.
    Name string
    Friendly name for the resource server. Cannot include < or > characters.
    SigningAlg string
    Algorithm used to sign JWTs. Options include HS256 and RS256.
    SigningSecret string
    Secret used to sign tokens when using symmetric algorithms (HS256).
    SkipConsentForVerifiableFirstPartyClients bool
    Indicates whether to skip user consent for applications flagged as first party.
    TokenDialect string
    Dialect of access tokens that should be issued for this resource server. Options include access_token, rfc9068_profile, access_token_authz, and rfc9068_profile_authz. access_token is a JWT containing standard Auth0 claims. rfc9068_profile is a JWT conforming to the IETF JWT Access Token Profile. access_token_authz is a JWT containing standard Auth0 claims, including RBAC permissions claims. rfc9068_profile_authz is a JWT conforming to the IETF JWT Access Token Profile, including RBAC permissions claims. RBAC permissions claims are available if RBAC (enforce_policies) is enabled for this API. For more details, refer to Access Token Profiles.
    TokenLifetime int
    Number of seconds during which access tokens issued for this resource server from the token endpoint remain valid.
    TokenLifetimeForWeb int
    Number of seconds during which access tokens issued for this resource server via implicit or hybrid flows remain valid. Cannot be greater than the token_lifetime value.
    VerificationLocation string
    URL from which to retrieve JWKs for this resource server. Used for verifying the JWT sent to Auth0 for token introspection.
    allowOfflineAccess Boolean
    Indicates whether refresh tokens can be issued for this resource server.
    enforcePolicies Boolean
    If this setting is enabled, RBAC authorization policies will be enforced for this API. Role and permission assignments will be evaluated during the login transaction.
    identifier String
    Unique identifier for the resource server. Used as the audience parameter for authorization calls. Cannot be changed once set.
    name String
    Friendly name for the resource server. Cannot include < or > characters.
    signingAlg String
    Algorithm used to sign JWTs. Options include HS256 and RS256.
    signingSecret String
    Secret used to sign tokens when using symmetric algorithms (HS256).
    skipConsentForVerifiableFirstPartyClients Boolean
    Indicates whether to skip user consent for applications flagged as first party.
    tokenDialect String
    Dialect of access tokens that should be issued for this resource server. Options include access_token, rfc9068_profile, access_token_authz, and rfc9068_profile_authz. access_token is a JWT containing standard Auth0 claims. rfc9068_profile is a JWT conforming to the IETF JWT Access Token Profile. access_token_authz is a JWT containing standard Auth0 claims, including RBAC permissions claims. rfc9068_profile_authz is a JWT conforming to the IETF JWT Access Token Profile, including RBAC permissions claims. RBAC permissions claims are available if RBAC (enforce_policies) is enabled for this API. For more details, refer to Access Token Profiles.
    tokenLifetime Integer
    Number of seconds during which access tokens issued for this resource server from the token endpoint remain valid.
    tokenLifetimeForWeb Integer
    Number of seconds during which access tokens issued for this resource server via implicit or hybrid flows remain valid. Cannot be greater than the token_lifetime value.
    verificationLocation String
    URL from which to retrieve JWKs for this resource server. Used for verifying the JWT sent to Auth0 for token introspection.
    allowOfflineAccess boolean
    Indicates whether refresh tokens can be issued for this resource server.
    enforcePolicies boolean
    If this setting is enabled, RBAC authorization policies will be enforced for this API. Role and permission assignments will be evaluated during the login transaction.
    identifier string
    Unique identifier for the resource server. Used as the audience parameter for authorization calls. Cannot be changed once set.
    name string
    Friendly name for the resource server. Cannot include < or > characters.
    signingAlg string
    Algorithm used to sign JWTs. Options include HS256 and RS256.
    signingSecret string
    Secret used to sign tokens when using symmetric algorithms (HS256).
    skipConsentForVerifiableFirstPartyClients boolean
    Indicates whether to skip user consent for applications flagged as first party.
    tokenDialect string
    Dialect of access tokens that should be issued for this resource server. Options include access_token, rfc9068_profile, access_token_authz, and rfc9068_profile_authz. access_token is a JWT containing standard Auth0 claims. rfc9068_profile is a JWT conforming to the IETF JWT Access Token Profile. access_token_authz is a JWT containing standard Auth0 claims, including RBAC permissions claims. rfc9068_profile_authz is a JWT conforming to the IETF JWT Access Token Profile, including RBAC permissions claims. RBAC permissions claims are available if RBAC (enforce_policies) is enabled for this API. For more details, refer to Access Token Profiles.
    tokenLifetime number
    Number of seconds during which access tokens issued for this resource server from the token endpoint remain valid.
    tokenLifetimeForWeb number
    Number of seconds during which access tokens issued for this resource server via implicit or hybrid flows remain valid. Cannot be greater than the token_lifetime value.
    verificationLocation string
    URL from which to retrieve JWKs for this resource server. Used for verifying the JWT sent to Auth0 for token introspection.
    allow_offline_access bool
    Indicates whether refresh tokens can be issued for this resource server.
    enforce_policies bool
    If this setting is enabled, RBAC authorization policies will be enforced for this API. Role and permission assignments will be evaluated during the login transaction.
    identifier str
    Unique identifier for the resource server. Used as the audience parameter for authorization calls. Cannot be changed once set.
    name str
    Friendly name for the resource server. Cannot include < or > characters.
    signing_alg str
    Algorithm used to sign JWTs. Options include HS256 and RS256.
    signing_secret str
    Secret used to sign tokens when using symmetric algorithms (HS256).
    skip_consent_for_verifiable_first_party_clients bool
    Indicates whether to skip user consent for applications flagged as first party.
    token_dialect str
    Dialect of access tokens that should be issued for this resource server. Options include access_token, rfc9068_profile, access_token_authz, and rfc9068_profile_authz. access_token is a JWT containing standard Auth0 claims. rfc9068_profile is a JWT conforming to the IETF JWT Access Token Profile. access_token_authz is a JWT containing standard Auth0 claims, including RBAC permissions claims. rfc9068_profile_authz is a JWT conforming to the IETF JWT Access Token Profile, including RBAC permissions claims. RBAC permissions claims are available if RBAC (enforce_policies) is enabled for this API. For more details, refer to Access Token Profiles.
    token_lifetime int
    Number of seconds during which access tokens issued for this resource server from the token endpoint remain valid.
    token_lifetime_for_web int
    Number of seconds during which access tokens issued for this resource server via implicit or hybrid flows remain valid. Cannot be greater than the token_lifetime value.
    verification_location str
    URL from which to retrieve JWKs for this resource server. Used for verifying the JWT sent to Auth0 for token introspection.
    allowOfflineAccess Boolean
    Indicates whether refresh tokens can be issued for this resource server.
    enforcePolicies Boolean
    If this setting is enabled, RBAC authorization policies will be enforced for this API. Role and permission assignments will be evaluated during the login transaction.
    identifier String
    Unique identifier for the resource server. Used as the audience parameter for authorization calls. Cannot be changed once set.
    name String
    Friendly name for the resource server. Cannot include < or > characters.
    signingAlg String
    Algorithm used to sign JWTs. Options include HS256 and RS256.
    signingSecret String
    Secret used to sign tokens when using symmetric algorithms (HS256).
    skipConsentForVerifiableFirstPartyClients Boolean
    Indicates whether to skip user consent for applications flagged as first party.
    tokenDialect String
    Dialect of access tokens that should be issued for this resource server. Options include access_token, rfc9068_profile, access_token_authz, and rfc9068_profile_authz. access_token is a JWT containing standard Auth0 claims. rfc9068_profile is a JWT conforming to the IETF JWT Access Token Profile. access_token_authz is a JWT containing standard Auth0 claims, including RBAC permissions claims. rfc9068_profile_authz is a JWT conforming to the IETF JWT Access Token Profile, including RBAC permissions claims. RBAC permissions claims are available if RBAC (enforce_policies) is enabled for this API. For more details, refer to Access Token Profiles.
    tokenLifetime Number
    Number of seconds during which access tokens issued for this resource server from the token endpoint remain valid.
    tokenLifetimeForWeb Number
    Number of seconds during which access tokens issued for this resource server via implicit or hybrid flows remain valid. Cannot be greater than the token_lifetime value.
    verificationLocation String
    URL from which to retrieve JWKs for this resource server. Used for verifying the JWT sent to Auth0 for token introspection.

    Import

    Existing resource servers can be imported using their ID.

    Example:

    $ pulumi import auth0:index/resourceServer:ResourceServer my_resource_server "XXXXXXXXXXXXXXXXXXXXXXX"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Auth0 pulumi/pulumi-auth0
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the auth0 Terraform Provider.
    auth0 logo
    Auth0 v3.7.1 published on Thursday, Sep 12, 2024 by Pulumi
    pulumi/pulumi-auth0