Class ResourceServer

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

Example Usage

using Pulumi;
using Auth0 = Pulumi.Auth0;

class MyStack : Stack
{
public MyStack()
{
    var myResourceServer = new Auth0.ResourceServer("myResourceServer", new Auth0.ResourceServerArgs
    {
        AllowOfflineAccess = true,
        Identifier = "https://api.example.com",
        Scopes = 
        {
            new Auth0.Inputs.ResourceServerScopeArgs
            {
                Description = "Create foos",
                Value = "create:foo",
            },
            new Auth0.Inputs.ResourceServerScopeArgs
            {
                Description = "Create bars",
                Value = "create:bar",
            },
        },
        SigningAlg = "RS256",
        SkipConsentForVerifiableFirstPartyClients = true,
        TokenLifetime = 8600,
    });
}

}

Inheritance

System.Object

Pulumi.Resource

Pulumi.CustomResource

ResourceServer

Inherited Members

Pulumi.CustomResource.Id

Pulumi.Resource.GetResourceType()

Pulumi.Resource.GetResourceName()

Pulumi.Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Auth0

Assembly: Pulumi.Auth0.dll

Syntax

public class ResourceServer : CustomResource

Constructors

ResourceServer(String, ResourceServerArgs, CustomResourceOptions)

Create a ResourceServer resource with the given unique name, arguments, and options.

Declaration

public ResourceServer(string name, ResourceServerArgs args = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ResourceServerArgs	args	The arguments used to populate this resource's properties
Pulumi.CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AllowOfflineAccess

Boolean. Indicates whether or not refresh tokens can be issued for this resource server.

Declaration

public Output<bool?> AllowOfflineAccess { get; }

Property Value

Type	Description
Pulumi.Output<System.Nullable<System.Boolean>>

EnforcePolicies

Boolean. Indicates whether or not authorization polices are enforced.

Declaration

public Output<bool?> EnforcePolicies { get; }

Property Value

Type	Description
Pulumi.Output<System.Nullable<System.Boolean>>

Identifier

String. Unique identifier for the resource server. Used as the audience parameter for authorization calls. Can not be changed once set.

Declaration

public Output<string> Identifier { get; }

Property Value

Type	Description
Pulumi.Output<System.String>

Name

String. Friendly name for the resource server. Cannot include < or > characters.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Pulumi.Output<System.String>

Options

Map(String). Used to store additional metadata

Declaration

public Output<ImmutableDictionary<string, string>> Options { get; }

Property Value

Type	Description
Pulumi.Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

Scopes

Set(Resource). List of permissions (scopes) used by this resource server. For details, see Scopes.

Declaration

public Output<ImmutableArray<ResourceServerScope>> Scopes { get; }

Property Value

Type	Description
Pulumi.Output<System.Collections.Immutable.ImmutableArray<ResourceServerScope>>

SigningAlg

String. Algorithm used to sign JWTs. Options include HS256 and RS256.

Declaration

public Output<string> SigningAlg { get; }

Property Value

Type	Description
Pulumi.Output<System.String>

SigningSecret

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

Declaration

public Output<string> SigningSecret { get; }

Property Value

Type	Description
Pulumi.Output<System.String>

SkipConsentForVerifiableFirstPartyClients

Boolean. Indicates whether or not to skip user consent for applications flagged as first party.

Declaration

public Output<bool?> SkipConsentForVerifiableFirstPartyClients { get; }

Property Value

Type	Description
Pulumi.Output<System.Nullable<System.Boolean>>

TokenDialect

String. Dialect of access tokens that should be issued for this resource server. Options include access_token or access_token_authz (includes permissions).

Declaration

public Output<string> TokenDialect { get; }

Property Value

Type	Description
Pulumi.Output<System.String>

TokenLifetime

Integer. Number of seconds during which access tokens issued for this resource server from the token endpoint remain valid.

Declaration

public Output<int> TokenLifetime { get; }

Property Value

Type	Description
Pulumi.Output<System.Int32>

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.

Declaration

public Output<int> TokenLifetimeForWeb { get; }

Property Value

Type	Description
Pulumi.Output<System.Int32>

VerificationLocation

String

Declaration

public Output<string> VerificationLocation { get; }

Property Value

Type	Description
Pulumi.Output<System.String>

Methods

Get(String, Input<String>, ResourceServerState, CustomResourceOptions)

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

Declaration

public static ResourceServer Get(string name, Input<string> id, ResourceServerState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Pulumi.Input<System.String>	id	The unique provider ID of the resource to lookup.
ResourceServerState	state	Any extra arguments used during the lookup.
Pulumi.CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
ResourceServer