onelogin 0.7.0, May 13 25

onelogin 0.7.0 published on Tuesday, May 13, 2025 by onelogin

onelogin.Users

Explore with Pulumi AI

onelogin 0.7.0 published on Tuesday, May 13, 2025 by onelogin

Create Users Resource

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

Constructor syntax

new Users(name: string, args: UsersArgs, opts?: CustomResourceOptions);

@overload
def Users(resource_name: str,
          args: UsersArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Users(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          email: Optional[str] = None,
          username: Optional[str] = None,
          lastname: Optional[str] = None,
          member_of: Optional[str] = None,
          directory_id: Optional[float] = None,
          distinguished_name: Optional[str] = None,
          custom_attributes: Optional[Mapping[str, str]] = None,
          external_id: Optional[float] = None,
          firstname: Optional[str] = None,
          group_id: Optional[float] = None,
          comment: Optional[str] = None,
          manager_ad_id: Optional[float] = None,
          manager_user_id: Optional[float] = None,
          department: Optional[str] = None,
          phone: Optional[str] = None,
          samaccountname: Optional[str] = None,
          state: Optional[float] = None,
          status: Optional[float] = None,
          title: Optional[str] = None,
          trusted_idp_id: Optional[float] = None,
          company: Optional[str] = None,
          userprincipalname: Optional[str] = None,
          users_id: Optional[str] = None)

func NewUsers(ctx *Context, name string, args UsersArgs, opts ...ResourceOption) (*Users, error)

public Users(string name, UsersArgs args, CustomResourceOptions? opts = null)

public Users(String name, UsersArgs args)
public Users(String name, UsersArgs args, CustomResourceOptions options)

type: onelogin:Users
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 UsersArgs: 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 UsersArgs: 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 UsersArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args UsersArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args UsersArgs: 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 usersResource = new Onelogin.Users("usersResource", new()
{
    Email = "string",
    Username = "string",
    Lastname = "string",
    MemberOf = "string",
    DirectoryId = 0,
    DistinguishedName = "string",
    CustomAttributes = 
    {
        { "string", "string" },
    },
    ExternalId = 0,
    Firstname = "string",
    GroupId = 0,
    Comment = "string",
    ManagerAdId = 0,
    ManagerUserId = 0,
    Department = "string",
    Phone = "string",
    Samaccountname = "string",
    State = 0,
    Status = 0,
    Title = "string",
    TrustedIdpId = 0,
    Company = "string",
    Userprincipalname = "string",
    UsersId = "string",
});

example, err := onelogin.NewUsers(ctx, "usersResource", &onelogin.UsersArgs{
	Email:             pulumi.String("string"),
	Username:          pulumi.String("string"),
	Lastname:          pulumi.String("string"),
	MemberOf:          pulumi.String("string"),
	DirectoryId:       pulumi.Float64(0),
	DistinguishedName: pulumi.String("string"),
	CustomAttributes: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ExternalId:        pulumi.Float64(0),
	Firstname:         pulumi.String("string"),
	GroupId:           pulumi.Float64(0),
	Comment:           pulumi.String("string"),
	ManagerAdId:       pulumi.Float64(0),
	ManagerUserId:     pulumi.Float64(0),
	Department:        pulumi.String("string"),
	Phone:             pulumi.String("string"),
	Samaccountname:    pulumi.String("string"),
	State:             pulumi.Float64(0),
	Status:            pulumi.Float64(0),
	Title:             pulumi.String("string"),
	TrustedIdpId:      pulumi.Float64(0),
	Company:           pulumi.String("string"),
	Userprincipalname: pulumi.String("string"),
	UsersId:           pulumi.String("string"),
})

var usersResource = new Users("usersResource", UsersArgs.builder()
    .email("string")
    .username("string")
    .lastname("string")
    .memberOf("string")
    .directoryId(0.0)
    .distinguishedName("string")
    .customAttributes(Map.of("string", "string"))
    .externalId(0.0)
    .firstname("string")
    .groupId(0.0)
    .comment("string")
    .managerAdId(0.0)
    .managerUserId(0.0)
    .department("string")
    .phone("string")
    .samaccountname("string")
    .state(0.0)
    .status(0.0)
    .title("string")
    .trustedIdpId(0.0)
    .company("string")
    .userprincipalname("string")
    .usersId("string")
    .build());

users_resource = onelogin.Users("usersResource",
    email="string",
    username="string",
    lastname="string",
    member_of="string",
    directory_id=0,
    distinguished_name="string",
    custom_attributes={
        "string": "string",
    },
    external_id=0,
    firstname="string",
    group_id=0,
    comment="string",
    manager_ad_id=0,
    manager_user_id=0,
    department="string",
    phone="string",
    samaccountname="string",
    state=0,
    status=0,
    title="string",
    trusted_idp_id=0,
    company="string",
    userprincipalname="string",
    users_id="string")

const usersResource = new onelogin.Users("usersResource", {
    email: "string",
    username: "string",
    lastname: "string",
    memberOf: "string",
    directoryId: 0,
    distinguishedName: "string",
    customAttributes: {
        string: "string",
    },
    externalId: 0,
    firstname: "string",
    groupId: 0,
    comment: "string",
    managerAdId: 0,
    managerUserId: 0,
    department: "string",
    phone: "string",
    samaccountname: "string",
    state: 0,
    status: 0,
    title: "string",
    trustedIdpId: 0,
    company: "string",
    userprincipalname: "string",
    usersId: "string",
});

type: onelogin:Users
properties:
    comment: string
    company: string
    customAttributes:
        string: string
    department: string
    directoryId: 0
    distinguishedName: string
    email: string
    externalId: 0
    firstname: string
    groupId: 0
    lastname: string
    managerAdId: 0
    managerUserId: 0
    memberOf: string
    phone: string
    samaccountname: string
    state: 0
    status: 0
    title: string
    trustedIdpId: 0
    username: string
    userprincipalname: string
    usersId: string

Users Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Users resource accepts the following input properties:

Email string
Username string
Comment string
Company string
CustomAttributes Dictionary<string, string>: Map of custom attribute key/value pairs. This field is being deprecated in favor of the onelogin.UserCustomAttributes resource.
Department string
DirectoryId double
DistinguishedName string
ExternalId double
Firstname string
GroupId double
Lastname string
ManagerAdId double
ManagerUserId double
MemberOf string
Phone string
Samaccountname string
State double
Status double
Title string
TrustedIdpId double
Userprincipalname string
UsersId string

Email string
Username string
Comment string
Company string
CustomAttributes map[string]string: Map of custom attribute key/value pairs. This field is being deprecated in favor of the onelogin.UserCustomAttributes resource.
Department string
DirectoryId float64
DistinguishedName string
ExternalId float64
Firstname string
GroupId float64
Lastname string
ManagerAdId float64
ManagerUserId float64
MemberOf string
Phone string
Samaccountname string
State float64
Status float64
Title string
TrustedIdpId float64
Userprincipalname string
UsersId string

email String
username String
comment String
company String
customAttributes Map<String,String>: Map of custom attribute key/value pairs. This field is being deprecated in favor of the onelogin.UserCustomAttributes resource.
department String
directoryId Double
distinguishedName String
externalId Double
firstname String
groupId Double
lastname String
managerAdId Double
managerUserId Double
memberOf String
phone String
samaccountname String
state Double
status Double
title String
trustedIdpId Double
userprincipalname String
usersId String

email string
username string
comment string
company string
customAttributes {[key: string]: string}: Map of custom attribute key/value pairs. This field is being deprecated in favor of the onelogin.UserCustomAttributes resource.
department string
directoryId number
distinguishedName string
externalId number
firstname string
groupId number
lastname string
managerAdId number
managerUserId number
memberOf string
phone string
samaccountname string
state number
status number
title string
trustedIdpId number
userprincipalname string
usersId string

email str
username str
comment str
company str
custom_attributes Mapping[str, str]: Map of custom attribute key/value pairs. This field is being deprecated in favor of the onelogin.UserCustomAttributes resource.
department str
directory_id float
distinguished_name str
external_id float
firstname str
group_id float
lastname str
manager_ad_id float
manager_user_id float
member_of str
phone str
samaccountname str
state float
status float
title str
trusted_idp_id float
userprincipalname str
users_id str

email String
username String
comment String
company String
customAttributes Map<String>: Map of custom attribute key/value pairs. This field is being deprecated in favor of the onelogin.UserCustomAttributes resource.
department String
directoryId Number
distinguishedName String
externalId Number
firstname String
groupId Number
lastname String
managerAdId Number
managerUserId Number
memberOf String
phone String
samaccountname String
state Number
status Number
title String
trustedIdpId Number
userprincipalname String
usersId String

Outputs

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

Get an existing Users 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?: UsersState, opts?: CustomResourceOptions): Users

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        company: Optional[str] = None,
        custom_attributes: Optional[Mapping[str, str]] = None,
        department: Optional[str] = None,
        directory_id: Optional[float] = None,
        distinguished_name: Optional[str] = None,
        email: Optional[str] = None,
        external_id: Optional[float] = None,
        firstname: Optional[str] = None,
        group_id: Optional[float] = None,
        lastname: Optional[str] = None,
        manager_ad_id: Optional[float] = None,
        manager_user_id: Optional[float] = None,
        member_of: Optional[str] = None,
        phone: Optional[str] = None,
        samaccountname: Optional[str] = None,
        state: Optional[float] = None,
        status: Optional[float] = None,
        title: Optional[str] = None,
        trusted_idp_id: Optional[float] = None,
        username: Optional[str] = None,
        userprincipalname: Optional[str] = None,
        users_id: Optional[str] = None) -> Users

func GetUsers(ctx *Context, name string, id IDInput, state *UsersState, opts ...ResourceOption) (*Users, error)

public static Users Get(string name, Input<string> id, UsersState? state, CustomResourceOptions? opts = null)

public static Users get(String name, Output<String> id, UsersState state, CustomResourceOptions options)

resources:  _:    type: onelogin:Users    get:      id: ${id}

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:

Comment string
Company string
CustomAttributes Dictionary<string, string>: Map of custom attribute key/value pairs. This field is being deprecated in favor of the onelogin.UserCustomAttributes resource.
Department string
DirectoryId double
DistinguishedName string
Email string
ExternalId double
Firstname string
GroupId double
Lastname string
ManagerAdId double
ManagerUserId double
MemberOf string
Phone string
Samaccountname string
State double
Status double
Title string
TrustedIdpId double
Username string
Userprincipalname string
UsersId string

Comment string
Company string
CustomAttributes map[string]string: Map of custom attribute key/value pairs. This field is being deprecated in favor of the onelogin.UserCustomAttributes resource.
Department string
DirectoryId float64
DistinguishedName string
Email string
ExternalId float64
Firstname string
GroupId float64
Lastname string
ManagerAdId float64
ManagerUserId float64
MemberOf string
Phone string
Samaccountname string
State float64
Status float64
Title string
TrustedIdpId float64
Username string
Userprincipalname string
UsersId string

comment String
company String
customAttributes Map<String,String>: Map of custom attribute key/value pairs. This field is being deprecated in favor of the onelogin.UserCustomAttributes resource.
department String
directoryId Double
distinguishedName String
email String
externalId Double
firstname String
groupId Double
lastname String
managerAdId Double
managerUserId Double
memberOf String
phone String
samaccountname String
state Double
status Double
title String
trustedIdpId Double
username String
userprincipalname String
usersId String

comment string
company string
customAttributes {[key: string]: string}: Map of custom attribute key/value pairs. This field is being deprecated in favor of the onelogin.UserCustomAttributes resource.
department string
directoryId number
distinguishedName string
email string
externalId number
firstname string
groupId number
lastname string
managerAdId number
managerUserId number
memberOf string
phone string
samaccountname string
state number
status number
title string
trustedIdpId number
username string
userprincipalname string
usersId string

comment str
company str
custom_attributes Mapping[str, str]: Map of custom attribute key/value pairs. This field is being deprecated in favor of the onelogin.UserCustomAttributes resource.
department str
directory_id float
distinguished_name str
email str
external_id float
firstname str
group_id float
lastname str
manager_ad_id float
manager_user_id float
member_of str
phone str
samaccountname str
state float
status float
title str
trusted_idp_id float
username str
userprincipalname str
users_id str

comment String
company String
customAttributes Map<String>: Map of custom attribute key/value pairs. This field is being deprecated in favor of the onelogin.UserCustomAttributes resource.
department String
directoryId Number
distinguishedName String
email String
externalId Number
firstname String
groupId Number
lastname String
managerAdId Number
managerUserId Number
memberOf String
phone String
samaccountname String
state Number
status Number
title String
trustedIdpId Number
username String
userprincipalname String
usersId String

Package Details

Repository: onelogin onelogin/terraform-provider-onelogin
License
Notes: This Pulumi package is based on the onelogin Terraform Provider.

onelogin 0.7.0 published on Tuesday, May 13, 2025 by onelogin

onelogin/terraform-provider-onelogin

onelogin.Users

On this page

On this page

Create Users Resource

Constructor syntax

Parameters

Constructor example

Users Resource Properties

Inputs

Outputs

Look up Existing Users Resource

Package Details

On this page

On this page