Docs Packages
  1. Pulumi Registry
  2. FusionAuth
  3. API Docs
  4. FusionAuthRegistration
fusionauth logo
FusionAuth v2.17.0, Mar 24 23

fusionauth.FusionAuthRegistration

Explore with Pulumi AI

# Registration Resource

A registration is the association between a User and an Application that they log into.

Registrations API

Example Usage

using System.Collections.Generic;
using Pulumi;
using Fusionauth = theogravity.Fusionauth;

return await Deployment.RunAsync(() => 
{
    var example = new Fusionauth.FusionAuthRegistration("example", new()
    {
        UserId = fusionauth_user.Example.Id,
        ApplicationId = data.Fusionauth_application.FusionAuth.Id,
        Roles = new[]
        {
            "admin",
        },
        Username = "theadmin",
    });

});

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/theogravity/pulumi-fusionauth/sdk/v2/go/fusionauth"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fusionauth.NewFusionAuthRegistration(ctx, "example", &fusionauth.FusionAuthRegistrationArgs{
			UserId:        pulumi.Any(fusionauth_user.Example.Id),
			ApplicationId: pulumi.Any(data.Fusionauth_application.FusionAuth.Id),
			Roles: pulumi.StringArray{
				pulumi.String("admin"),
			},
			Username: pulumi.String("theadmin"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fusionauth.FusionAuthRegistration;
import com.pulumi.fusionauth.FusionAuthRegistrationArgs;
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 example = new FusionAuthRegistration("example", FusionAuthRegistrationArgs.builder()        
            .userId(fusionauth_user.example().id())
            .applicationId(data.fusionauth_application().FusionAuth().id())
            .roles("admin")
            .username("theadmin")
            .build());

    }
}

import pulumi
import theogravity_pulumi-fusionauth as fusionauth

example = fusionauth.FusionAuthRegistration("example",
    user_id=fusionauth_user["example"]["id"],
    application_id=data["fusionauth_application"]["FusionAuth"]["id"],
    roles=["admin"],
    username="theadmin")

import * as pulumi from "@pulumi/pulumi";
import * as fusionauth from "pulumi-fusionauth";

const example = new fusionauth.FusionAuthRegistration("example", {
    userId: fusionauth_user.example.id,
    applicationId: data.fusionauth_application.FusionAuth.id,
    roles: ["admin"],
    username: "theadmin",
});

resources:
  example:
    type: fusionauth:FusionAuthRegistration
    properties:
      userId: ${fusionauth_user.example.id}
      applicationId: ${data.fusionauth_application.FusionAuth.id}
      roles:
        - admin
      username: theadmin

Create FusionAuthRegistration Resource

new FusionAuthRegistration(name: string, args: FusionAuthRegistrationArgs, opts?: CustomResourceOptions);
@overload
def FusionAuthRegistration(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           application_id: Optional[str] = None,
                           authentication_token: Optional[str] = None,
                           data: Optional[Mapping[str, Any]] = None,
                           generate_authentication_token: Optional[bool] = None,
                           preferred_languages: Optional[Sequence[str]] = None,
                           roles: Optional[Sequence[str]] = None,
                           skip_registration_validation: Optional[bool] = None,
                           timezone: Optional[str] = None,
                           user_id: Optional[str] = None,
                           username: Optional[str] = None)
@overload
def FusionAuthRegistration(resource_name: str,
                           args: FusionAuthRegistrationArgs,
                           opts: Optional[ResourceOptions] = None)
func NewFusionAuthRegistration(ctx *Context, name string, args FusionAuthRegistrationArgs, opts ...ResourceOption) (*FusionAuthRegistration, error)
public FusionAuthRegistration(string name, FusionAuthRegistrationArgs args, CustomResourceOptions? opts = null)
public FusionAuthRegistration(String name, FusionAuthRegistrationArgs args)
public FusionAuthRegistration(String name, FusionAuthRegistrationArgs args, CustomResourceOptions options)

type: fusionauth:FusionAuthRegistration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args FusionAuthRegistrationArgs
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 FusionAuthRegistrationArgs
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 FusionAuthRegistrationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args FusionAuthRegistrationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args FusionAuthRegistrationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

FusionAuthRegistration 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 FusionAuthRegistration resource accepts the following input properties:

ApplicationId string

The Id of the Application that this registration is for.

UserId string

The Id of the User that is registering for the Application.

AuthenticationToken string

The authentication token that may be used in place of the User’s password when authenticating against this application represented by this registration. This parameter is ignored if generateAuthenticationToken is set to true and instead the value will be generated.

Data Dictionary<string, object>

An object that can hold any information about the User for this registration that should be persisted.

GenerateAuthenticationToken bool

Determines if FusionAuth should generate an Authentication Token for this registration.

PreferredLanguages List<string>

An array of locale strings that give, in order, the User’s preferred languages for this registration. These are important for email templates and other localizable text.

Roles List<string>

The list of roles that the User has for this registration.

SkipRegistrationValidation bool

Indicates to FusionAuth that it should skip registration verification even if it is enabled for the Application.

Timezone string

The User’s preferred timezone for this registration. The string will be in an IANA time zone format.

Username string

The username of the User for this registration only.

ApplicationId string

The Id of the Application that this registration is for.

UserId string

The Id of the User that is registering for the Application.

AuthenticationToken string

The authentication token that may be used in place of the User’s password when authenticating against this application represented by this registration. This parameter is ignored if generateAuthenticationToken is set to true and instead the value will be generated.

Data map[string]interface{}

An object that can hold any information about the User for this registration that should be persisted.

GenerateAuthenticationToken bool

Determines if FusionAuth should generate an Authentication Token for this registration.

PreferredLanguages []string

An array of locale strings that give, in order, the User’s preferred languages for this registration. These are important for email templates and other localizable text.

Roles []string

The list of roles that the User has for this registration.

SkipRegistrationValidation bool

Indicates to FusionAuth that it should skip registration verification even if it is enabled for the Application.

Timezone string

The User’s preferred timezone for this registration. The string will be in an IANA time zone format.

Username string

The username of the User for this registration only.

applicationId String

The Id of the Application that this registration is for.

userId String

The Id of the User that is registering for the Application.

authenticationToken String

The authentication token that may be used in place of the User’s password when authenticating against this application represented by this registration. This parameter is ignored if generateAuthenticationToken is set to true and instead the value will be generated.

data Map<String,Object>

An object that can hold any information about the User for this registration that should be persisted.

generateAuthenticationToken Boolean

Determines if FusionAuth should generate an Authentication Token for this registration.

preferredLanguages List<String>

An array of locale strings that give, in order, the User’s preferred languages for this registration. These are important for email templates and other localizable text.

roles List<String>

The list of roles that the User has for this registration.

skipRegistrationValidation Boolean

Indicates to FusionAuth that it should skip registration verification even if it is enabled for the Application.

timezone String

The User’s preferred timezone for this registration. The string will be in an IANA time zone format.

username String

The username of the User for this registration only.

applicationId string

The Id of the Application that this registration is for.

userId string

The Id of the User that is registering for the Application.

authenticationToken string

The authentication token that may be used in place of the User’s password when authenticating against this application represented by this registration. This parameter is ignored if generateAuthenticationToken is set to true and instead the value will be generated.

data {[key: string]: any}

An object that can hold any information about the User for this registration that should be persisted.

generateAuthenticationToken boolean

Determines if FusionAuth should generate an Authentication Token for this registration.

preferredLanguages string[]

An array of locale strings that give, in order, the User’s preferred languages for this registration. These are important for email templates and other localizable text.

roles string[]

The list of roles that the User has for this registration.

skipRegistrationValidation boolean

Indicates to FusionAuth that it should skip registration verification even if it is enabled for the Application.

timezone string

The User’s preferred timezone for this registration. The string will be in an IANA time zone format.

username string

The username of the User for this registration only.

application_id str

The Id of the Application that this registration is for.

user_id str

The Id of the User that is registering for the Application.

authentication_token str

The authentication token that may be used in place of the User’s password when authenticating against this application represented by this registration. This parameter is ignored if generateAuthenticationToken is set to true and instead the value will be generated.

data Mapping[str, Any]

An object that can hold any information about the User for this registration that should be persisted.

generate_authentication_token bool

Determines if FusionAuth should generate an Authentication Token for this registration.

preferred_languages Sequence[str]

An array of locale strings that give, in order, the User’s preferred languages for this registration. These are important for email templates and other localizable text.

roles Sequence[str]

The list of roles that the User has for this registration.

skip_registration_validation bool

Indicates to FusionAuth that it should skip registration verification even if it is enabled for the Application.

timezone str

The User’s preferred timezone for this registration. The string will be in an IANA time zone format.

username str

The username of the User for this registration only.

applicationId String

The Id of the Application that this registration is for.

userId String

The Id of the User that is registering for the Application.

authenticationToken String

The authentication token that may be used in place of the User’s password when authenticating against this application represented by this registration. This parameter is ignored if generateAuthenticationToken is set to true and instead the value will be generated.

data Map<Any>

An object that can hold any information about the User for this registration that should be persisted.

generateAuthenticationToken Boolean

Determines if FusionAuth should generate an Authentication Token for this registration.

preferredLanguages List<String>

An array of locale strings that give, in order, the User’s preferred languages for this registration. These are important for email templates and other localizable text.

roles List<String>

The list of roles that the User has for this registration.

skipRegistrationValidation Boolean

Indicates to FusionAuth that it should skip registration verification even if it is enabled for the Application.

timezone String

The User’s preferred timezone for this registration. The string will be in an IANA time zone format.

username String

The username of the User for this registration only.

Outputs

All input properties are implicitly available as output properties. Additionally, the FusionAuthRegistration 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 FusionAuthRegistration Resource

Get an existing FusionAuthRegistration 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?: FusionAuthRegistrationState, opts?: CustomResourceOptions): FusionAuthRegistration
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        application_id: Optional[str] = None,
        authentication_token: Optional[str] = None,
        data: Optional[Mapping[str, Any]] = None,
        generate_authentication_token: Optional[bool] = None,
        preferred_languages: Optional[Sequence[str]] = None,
        roles: Optional[Sequence[str]] = None,
        skip_registration_validation: Optional[bool] = None,
        timezone: Optional[str] = None,
        user_id: Optional[str] = None,
        username: Optional[str] = None) -> FusionAuthRegistration
func GetFusionAuthRegistration(ctx *Context, name string, id IDInput, state *FusionAuthRegistrationState, opts ...ResourceOption) (*FusionAuthRegistration, error)
public static FusionAuthRegistration Get(string name, Input<string> id, FusionAuthRegistrationState? state, CustomResourceOptions? opts = null)
public static FusionAuthRegistration get(String name, Output<String> id, FusionAuthRegistrationState 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:
ApplicationId string

The Id of the Application that this registration is for.

AuthenticationToken string

The authentication token that may be used in place of the User’s password when authenticating against this application represented by this registration. This parameter is ignored if generateAuthenticationToken is set to true and instead the value will be generated.

Data Dictionary<string, object>

An object that can hold any information about the User for this registration that should be persisted.

GenerateAuthenticationToken bool

Determines if FusionAuth should generate an Authentication Token for this registration.

PreferredLanguages List<string>

An array of locale strings that give, in order, the User’s preferred languages for this registration. These are important for email templates and other localizable text.

Roles List<string>

The list of roles that the User has for this registration.

SkipRegistrationValidation bool

Indicates to FusionAuth that it should skip registration verification even if it is enabled for the Application.

Timezone string

The User’s preferred timezone for this registration. The string will be in an IANA time zone format.

UserId string

The Id of the User that is registering for the Application.

Username string

The username of the User for this registration only.

ApplicationId string

The Id of the Application that this registration is for.

AuthenticationToken string

The authentication token that may be used in place of the User’s password when authenticating against this application represented by this registration. This parameter is ignored if generateAuthenticationToken is set to true and instead the value will be generated.

Data map[string]interface{}

An object that can hold any information about the User for this registration that should be persisted.

GenerateAuthenticationToken bool

Determines if FusionAuth should generate an Authentication Token for this registration.

PreferredLanguages []string

An array of locale strings that give, in order, the User’s preferred languages for this registration. These are important for email templates and other localizable text.

Roles []string

The list of roles that the User has for this registration.

SkipRegistrationValidation bool

Indicates to FusionAuth that it should skip registration verification even if it is enabled for the Application.

Timezone string

The User’s preferred timezone for this registration. The string will be in an IANA time zone format.

UserId string

The Id of the User that is registering for the Application.

Username string

The username of the User for this registration only.

applicationId String

The Id of the Application that this registration is for.

authenticationToken String

The authentication token that may be used in place of the User’s password when authenticating against this application represented by this registration. This parameter is ignored if generateAuthenticationToken is set to true and instead the value will be generated.

data Map<String,Object>

An object that can hold any information about the User for this registration that should be persisted.

generateAuthenticationToken Boolean

Determines if FusionAuth should generate an Authentication Token for this registration.

preferredLanguages List<String>

An array of locale strings that give, in order, the User’s preferred languages for this registration. These are important for email templates and other localizable text.

roles List<String>

The list of roles that the User has for this registration.

skipRegistrationValidation Boolean

Indicates to FusionAuth that it should skip registration verification even if it is enabled for the Application.

timezone String

The User’s preferred timezone for this registration. The string will be in an IANA time zone format.

userId String

The Id of the User that is registering for the Application.

username String

The username of the User for this registration only.

applicationId string

The Id of the Application that this registration is for.

authenticationToken string

The authentication token that may be used in place of the User’s password when authenticating against this application represented by this registration. This parameter is ignored if generateAuthenticationToken is set to true and instead the value will be generated.

data {[key: string]: any}

An object that can hold any information about the User for this registration that should be persisted.

generateAuthenticationToken boolean

Determines if FusionAuth should generate an Authentication Token for this registration.

preferredLanguages string[]

An array of locale strings that give, in order, the User’s preferred languages for this registration. These are important for email templates and other localizable text.

roles string[]

The list of roles that the User has for this registration.

skipRegistrationValidation boolean

Indicates to FusionAuth that it should skip registration verification even if it is enabled for the Application.

timezone string

The User’s preferred timezone for this registration. The string will be in an IANA time zone format.

userId string

The Id of the User that is registering for the Application.

username string

The username of the User for this registration only.

application_id str

The Id of the Application that this registration is for.

authentication_token str

The authentication token that may be used in place of the User’s password when authenticating against this application represented by this registration. This parameter is ignored if generateAuthenticationToken is set to true and instead the value will be generated.

data Mapping[str, Any]

An object that can hold any information about the User for this registration that should be persisted.

generate_authentication_token bool

Determines if FusionAuth should generate an Authentication Token for this registration.

preferred_languages Sequence[str]

An array of locale strings that give, in order, the User’s preferred languages for this registration. These are important for email templates and other localizable text.

roles Sequence[str]

The list of roles that the User has for this registration.

skip_registration_validation bool

Indicates to FusionAuth that it should skip registration verification even if it is enabled for the Application.

timezone str

The User’s preferred timezone for this registration. The string will be in an IANA time zone format.

user_id str

The Id of the User that is registering for the Application.

username str

The username of the User for this registration only.

applicationId String

The Id of the Application that this registration is for.

authenticationToken String

The authentication token that may be used in place of the User’s password when authenticating against this application represented by this registration. This parameter is ignored if generateAuthenticationToken is set to true and instead the value will be generated.

data Map<Any>

An object that can hold any information about the User for this registration that should be persisted.

generateAuthenticationToken Boolean

Determines if FusionAuth should generate an Authentication Token for this registration.

preferredLanguages List<String>

An array of locale strings that give, in order, the User’s preferred languages for this registration. These are important for email templates and other localizable text.

roles List<String>

The list of roles that the User has for this registration.

skipRegistrationValidation Boolean

Indicates to FusionAuth that it should skip registration verification even if it is enabled for the Application.

timezone String

The User’s preferred timezone for this registration. The string will be in an IANA time zone format.

userId String

The Id of the User that is registering for the Application.

username String

The username of the User for this registration only.

Package Details

Repository
fusionauth theogravity/pulumi-fusionauth
License
MIT
Notes

This Pulumi package is based on the fusionauth Terraform Provider.