user

package
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 15, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BaseSchema 

type BaseSchema struct {
	// contains filtered or unexported fields
}

Manages a User Base Schema property.

This resource allows you to configure a base user schema property.

> This content is derived from https://github.com/articulate/terraform-provider-okta/blob/master/website/docs/r/user_base_schema.html.markdown.

func GetBaseSchema 

func GetBaseSchema(ctx *pulumi.Context,
	name string, id pulumi.ID, state *BaseSchemaState, opts ...pulumi.ResourceOpt) (*BaseSchema, error)

GetBaseSchema gets an existing BaseSchema resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewBaseSchema 

func NewBaseSchema(ctx *pulumi.Context,
	name string, args *BaseSchemaArgs, opts ...pulumi.ResourceOpt) (*BaseSchema, error)

NewBaseSchema registers a new resource with the given unique name, arguments, and options.

func (*BaseSchema) ID 

func (r *BaseSchema) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*BaseSchema) Index 

func (r *BaseSchema) Index() *pulumi.StringOutput

The property name.

func (*BaseSchema) Master 

func (r *BaseSchema) Master() *pulumi.StringOutput

Master priority for the user schema property. It can be set to `"PROFILE_MASTER"` or `"OKTA"`.

func (*BaseSchema) Permissions 

func (r *BaseSchema) Permissions() *pulumi.StringOutput

Access control permissions for the property. It can be set to `"READ_WRITE"`, `"READ_ONLY"`, `"HIDE"`.

func (*BaseSchema) Required 

func (r *BaseSchema) Required() *pulumi.BoolOutput

Whether the property is required for this application's users.

func (*BaseSchema) Title 

func (r *BaseSchema) Title() *pulumi.StringOutput

The property display name.

func (*BaseSchema) Type 

func (r *BaseSchema) Type() *pulumi.StringOutput

The type of the schema property. It can be `"string"`, `"boolean"`, `"number"`, `"integer"`, `"array"`, or `"object"`.

func (*BaseSchema) URN 

func (r *BaseSchema) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type BaseSchemaArgs 

type BaseSchemaArgs struct {
	// The property name.
	Index interface{}
	// Master priority for the user schema property. It can be set to `"PROFILE_MASTER"` or `"OKTA"`.
	Master interface{}
	// Access control permissions for the property. It can be set to `"READ_WRITE"`, `"READ_ONLY"`, `"HIDE"`.
	Permissions interface{}
	// Whether the property is required for this application's users.
	Required interface{}
	// The property display name.
	Title interface{}
	// The type of the schema property. It can be `"string"`, `"boolean"`, `"number"`, `"integer"`, `"array"`, or `"object"`.
	Type interface{}
}

The set of arguments for constructing a BaseSchema resource.

type BaseSchemaState 

type BaseSchemaState struct {
	// The property name.
	Index interface{}
	// Master priority for the user schema property. It can be set to `"PROFILE_MASTER"` or `"OKTA"`.
	Master interface{}
	// Access control permissions for the property. It can be set to `"READ_WRITE"`, `"READ_ONLY"`, `"HIDE"`.
	Permissions interface{}
	// Whether the property is required for this application's users.
	Required interface{}
	// The property display name.
	Title interface{}
	// The type of the schema property. It can be `"string"`, `"boolean"`, `"number"`, `"integer"`, `"array"`, or `"object"`.
	Type interface{}
}

Input properties used for looking up and filtering BaseSchema resources.

type GetUserArgs 

type GetUserArgs struct {
	// Map of search criteria. It supports the following properties.
	Searches interface{}
}

A collection of arguments for invoking getUser.

type GetUserResult 

type GetUserResult struct {
	// Administrator roles assigned to user.
	AdminRoles interface{}
	// user profile property.
	City interface{}
	// user profile property.
	CostCenter interface{}
	// user profile property.
	CountryCode interface{}
	// raw JSON containing all custom profile attributes.
	CustomProfileAttributes interface{}
	// user profile property.
	Department interface{}
	// user profile property.
	DisplayName interface{}
	// user profile property.
	Division interface{}
	// user profile property.
	Email interface{}
	// user profile property.
	EmployeeNumber interface{}
	// user profile property.
	FirstName interface{}
	// user profile property.
	GroupMemberships interface{}
	// user profile property.
	HonorificPrefix interface{}
	// user profile property.
	HonorificSuffix interface{}
	// user profile property.
	LastName interface{}
	// user profile property.
	Locale interface{}
	// user profile property.
	Login interface{}
	// user profile property.
	Manager interface{}
	// user profile property.
	ManagerId interface{}
	// user profile property.
	MiddleName interface{}
	// user profile property.
	MobilePhone interface{}
	// user profile property.
	NickName interface{}
	// user profile property.
	Organization interface{}
	// user profile property.
	PostalAddress interface{}
	// user profile property.
	PreferredLanguage interface{}
	// user profile property.
	PrimaryPhone interface{}
	// user profile property.
	ProfileUrl interface{}
	Searches   interface{}
	// user profile property.
	SecondEmail interface{}
	// user profile property.
	State interface{}
	// user profile property.
	Status interface{}
	// user profile property.
	StreetAddress interface{}
	// user profile property.
	Timezone interface{}
	// user profile property.
	Title interface{}
	// user profile property.
	UserType interface{}
	// user profile property.
	ZipCode interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getUser.

func LookupUser 

func LookupUser(ctx *pulumi.Context, args *GetUserArgs) (*GetUserResult, error)

Use this data source to retrieve a users from Okta.

> This content is derived from https://github.com/articulate/terraform-provider-okta/blob/master/website/docs/d/user.html.markdown.

type GetUsersArgs 

type GetUsersArgs struct {
	// Map of search criteria to use to find users. It supports the following properties.
	Searches interface{}
	Users    interface{}
}

A collection of arguments for invoking getUsers.

type GetUsersResult 

type GetUsersResult struct {
	Searches interface{}
	// collection of users retrieved from Okta with the following properties.
	Users interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getUsers.

func LookupUsers 

func LookupUsers(ctx *pulumi.Context, args *GetUsersArgs) (*GetUsersResult, error)

Use this data source to retrieve a list of users from Okta.

> This content is derived from https://github.com/articulate/terraform-provider-okta/blob/master/website/docs/d/users.html.markdown.

type Schema 

type Schema struct {
	// contains filtered or unexported fields
}

Creates a User Schema property.

This resource allows you to create and configure a custom user schema property.

> This content is derived from https://github.com/articulate/terraform-provider-okta/blob/master/website/docs/r/user_schema.html.markdown.

func GetSchema 

func GetSchema(ctx *pulumi.Context,
	name string, id pulumi.ID, state *SchemaState, opts ...pulumi.ResourceOpt) (*Schema, error)

GetSchema gets an existing Schema resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewSchema 

func NewSchema(ctx *pulumi.Context,
	name string, args *SchemaArgs, opts ...pulumi.ResourceOpt) (*Schema, error)

NewSchema registers a new resource with the given unique name, arguments, and options.

func (*Schema) ArrayEnums 

func (r *Schema) ArrayEnums() *pulumi.ArrayOutput

Array of values that an array property's items can be set to.

func (*Schema) ArrayOneOfs 

func (r *Schema) ArrayOneOfs() *pulumi.ArrayOutput

Display name and value an enum array can be set to.

func (*Schema) ArrayType 

func (r *Schema) ArrayType() *pulumi.StringOutput

The type of the array elements if `type` is set to `"array"`.

func (*Schema) Description 

func (r *Schema) Description() *pulumi.StringOutput

The description of the user schema property.

func (*Schema) Enums 

func (r *Schema) Enums() *pulumi.ArrayOutput

Array of values a primitive property can be set to. See `arrayEnum` for arrays.

func (*Schema) ExternalName 

func (r *Schema) ExternalName() *pulumi.StringOutput

External name of the user schema property.

func (*Schema) ID 

func (r *Schema) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Schema) Index 

func (r *Schema) Index() *pulumi.StringOutput

The property name.

func (*Schema) Master 

func (r *Schema) Master() *pulumi.StringOutput

Master priority for the user schema property. It can be set to `"PROFILE_MASTER"` or `"OKTA"`.

func (*Schema) MaxLength 

func (r *Schema) MaxLength() *pulumi.IntOutput

The maximum length of the user property value. Only applies to type `"string"`.

func (*Schema) MinLength 

func (r *Schema) MinLength() *pulumi.IntOutput

The minimum length of the user property value. Only applies to type `"string"`.

func (*Schema) OneOfs 

func (r *Schema) OneOfs() *pulumi.ArrayOutput

Array of maps containing a mapping for display name to enum value.

func (*Schema) Permissions 

func (r *Schema) Permissions() *pulumi.StringOutput

Access control permissions for the property. It can be set to `"READ_WRITE"`, `"READ_ONLY"`, `"HIDE"`.

func (*Schema) Required 

func (r *Schema) Required() *pulumi.BoolOutput

Whether the property is required for this application's users.

func (*Schema) Scope 

func (r *Schema) Scope() *pulumi.StringOutput

determines whether an app user attribute can be set at the Individual or Group Level.

func (*Schema) Title 

func (r *Schema) Title() *pulumi.StringOutput

display name for the enum value.

func (*Schema) Type 

func (r *Schema) Type() *pulumi.StringOutput

The type of the schema property. It can be `"string"`, `"boolean"`, `"number"`, `"integer"`, `"array"`, or `"object"`.

func (*Schema) URN 

func (r *Schema) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type SchemaArgs 

type SchemaArgs struct {
	// Array of values that an array property's items can be set to.
	ArrayEnums interface{}
	// Display name and value an enum array can be set to.
	ArrayOneOfs interface{}
	// The type of the array elements if `type` is set to `"array"`.
	ArrayType interface{}
	// The description of the user schema property.
	Description interface{}
	// Array of values a primitive property can be set to. See `arrayEnum` for arrays.
	Enums interface{}
	// External name of the user schema property.
	ExternalName interface{}
	// The property name.
	Index interface{}
	// Master priority for the user schema property. It can be set to `"PROFILE_MASTER"` or `"OKTA"`.
	Master interface{}
	// The maximum length of the user property value. Only applies to type `"string"`.
	MaxLength interface{}
	// The minimum length of the user property value. Only applies to type `"string"`.
	MinLength interface{}
	// Array of maps containing a mapping for display name to enum value.
	OneOfs interface{}
	// Access control permissions for the property. It can be set to `"READ_WRITE"`, `"READ_ONLY"`, `"HIDE"`.
	Permissions interface{}
	// Whether the property is required for this application's users.
	Required interface{}
	// determines whether an app user attribute can be set at the Individual or Group Level.
	Scope interface{}
	// display name for the enum value.
	Title interface{}
	// The type of the schema property. It can be `"string"`, `"boolean"`, `"number"`, `"integer"`, `"array"`, or `"object"`.
	Type interface{}
}

The set of arguments for constructing a Schema resource.

type SchemaState 

type SchemaState struct {
	// Array of values that an array property's items can be set to.
	ArrayEnums interface{}
	// Display name and value an enum array can be set to.
	ArrayOneOfs interface{}
	// The type of the array elements if `type` is set to `"array"`.
	ArrayType interface{}
	// The description of the user schema property.
	Description interface{}
	// Array of values a primitive property can be set to. See `arrayEnum` for arrays.
	Enums interface{}
	// External name of the user schema property.
	ExternalName interface{}
	// The property name.
	Index interface{}
	// Master priority for the user schema property. It can be set to `"PROFILE_MASTER"` or `"OKTA"`.
	Master interface{}
	// The maximum length of the user property value. Only applies to type `"string"`.
	MaxLength interface{}
	// The minimum length of the user property value. Only applies to type `"string"`.
	MinLength interface{}
	// Array of maps containing a mapping for display name to enum value.
	OneOfs interface{}
	// Access control permissions for the property. It can be set to `"READ_WRITE"`, `"READ_ONLY"`, `"HIDE"`.
	Permissions interface{}
	// Whether the property is required for this application's users.
	Required interface{}
	// determines whether an app user attribute can be set at the Individual or Group Level.
	Scope interface{}
	// display name for the enum value.
	Title interface{}
	// The type of the schema property. It can be `"string"`, `"boolean"`, `"number"`, `"integer"`, `"array"`, or `"object"`.
	Type interface{}
}

Input properties used for looking up and filtering Schema resources.

type User 

type User struct {
	// contains filtered or unexported fields
}

Creates an Okta User.

This resource allows you to create and configure an Okta User.

> This content is derived from https://github.com/articulate/terraform-provider-okta/blob/master/website/docs/r/user.html.markdown.

func GetUser 

func GetUser(ctx *pulumi.Context,
	name string, id pulumi.ID, state *UserState, opts ...pulumi.ResourceOpt) (*User, error)

GetUser gets an existing User resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewUser 

func NewUser(ctx *pulumi.Context,
	name string, args *UserArgs, opts ...pulumi.ResourceOpt) (*User, error)

NewUser registers a new resource with the given unique name, arguments, and options.

func (*User) AdminRoles 

func (r *User) AdminRoles() *pulumi.ArrayOutput

Administrator roles assigned to User.

func (*User) City 

func (r *User) City() *pulumi.StringOutput

User profile property.

func (*User) CostCenter 

func (r *User) CostCenter() *pulumi.StringOutput

User profile property.

func (*User) CountryCode 

func (r *User) CountryCode() *pulumi.StringOutput

User profile property.

func (*User) CustomProfileAttributes 

func (r *User) CustomProfileAttributes() *pulumi.StringOutput

raw JSON containing all custom profile attributes.

func (*User) Department 

func (r *User) Department() *pulumi.StringOutput

User profile property.

func (*User) DisplayName 

func (r *User) DisplayName() *pulumi.StringOutput

User profile property.

func (*User) Division 

func (r *User) Division() *pulumi.StringOutput

User profile property.

func (*User) Email 

func (r *User) Email() *pulumi.StringOutput

User profile property.

func (*User) EmployeeNumber 

func (r *User) EmployeeNumber() *pulumi.StringOutput

User profile property.

func (*User) FirstName 

func (r *User) FirstName() *pulumi.StringOutput

User's First Name, required by default.

func (*User) GroupMemberships 

func (r *User) GroupMemberships() *pulumi.ArrayOutput

User profile property.

func (*User) HonorificPrefix 

func (r *User) HonorificPrefix() *pulumi.StringOutput

User profile property.

func (*User) HonorificSuffix 

func (r *User) HonorificSuffix() *pulumi.StringOutput

User profile property.

func (*User) ID 

func (r *User) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*User) LastName 

func (r *User) LastName() *pulumi.StringOutput

User's Last Name, required by default.

func (*User) Locale 

func (r *User) Locale() *pulumi.StringOutput

User profile property.

func (*User) Login 

func (r *User) Login() *pulumi.StringOutput

User profile property.

func (*User) Manager 

func (r *User) Manager() *pulumi.StringOutput

User profile property.

func (*User) ManagerId 

func (r *User) ManagerId() *pulumi.StringOutput

User profile property.

func (*User) MiddleName 

func (r *User) MiddleName() *pulumi.StringOutput

User profile property.

func (*User) MobilePhone 

func (r *User) MobilePhone() *pulumi.StringOutput

User profile property.

func (*User) NickName 

func (r *User) NickName() *pulumi.StringOutput

User profile property.

func (*User) Organization 

func (r *User) Organization() *pulumi.StringOutput

User profile property.

func (*User) PostalAddress 

func (r *User) PostalAddress() *pulumi.StringOutput

User profile property.

func (*User) PreferredLanguage 

func (r *User) PreferredLanguage() *pulumi.StringOutput

User profile property.

func (*User) PrimaryPhone 

func (r *User) PrimaryPhone() *pulumi.StringOutput

User profile property.

func (*User) ProfileUrl 

func (r *User) ProfileUrl() *pulumi.StringOutput

User profile property.

func (*User) RawStatus 

func (r *User) RawStatus() *pulumi.StringOutput

The raw status of the User in Okta - (status is mapped)

func (*User) SecondEmail 

func (r *User) SecondEmail() *pulumi.StringOutput

User profile property.

func (*User) State 

func (r *User) State() *pulumi.StringOutput

User profile property.

func (*User) Status 

func (r *User) Status() *pulumi.StringOutput

User profile property.

func (*User) StreetAddress 

func (r *User) StreetAddress() *pulumi.StringOutput

User profile property.

func (*User) Timezone 

func (r *User) Timezone() *pulumi.StringOutput

User profile property.

func (*User) Title 

func (r *User) Title() *pulumi.StringOutput

User profile property.

func (*User) URN 

func (r *User) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*User) UserType 

func (r *User) UserType() *pulumi.StringOutput

User profile property.

func (*User) ZipCode 

func (r *User) ZipCode() *pulumi.StringOutput

User profile property.

type UserArgs 

type UserArgs struct {
	// Administrator roles assigned to User.
	AdminRoles interface{}
	// User profile property.
	City interface{}
	// User profile property.
	CostCenter interface{}
	// User profile property.
	CountryCode interface{}
	// raw JSON containing all custom profile attributes.
	CustomProfileAttributes interface{}
	// User profile property.
	Department interface{}
	// User profile property.
	DisplayName interface{}
	// User profile property.
	Division interface{}
	// User profile property.
	Email interface{}
	// User profile property.
	EmployeeNumber interface{}
	// User's First Name, required by default.
	FirstName interface{}
	// User profile property.
	GroupMemberships interface{}
	// User profile property.
	HonorificPrefix interface{}
	// User profile property.
	HonorificSuffix interface{}
	// User's Last Name, required by default.
	LastName interface{}
	// User profile property.
	Locale interface{}
	// User profile property.
	Login interface{}
	// User profile property.
	Manager interface{}
	// User profile property.
	ManagerId interface{}
	// User profile property.
	MiddleName interface{}
	// User profile property.
	MobilePhone interface{}
	// User profile property.
	NickName interface{}
	// User profile property.
	Organization interface{}
	// User profile property.
	PostalAddress interface{}
	// User profile property.
	PreferredLanguage interface{}
	// User profile property.
	PrimaryPhone interface{}
	// User profile property.
	ProfileUrl interface{}
	// User profile property.
	SecondEmail interface{}
	// User profile property.
	State interface{}
	// User profile property.
	Status interface{}
	// User profile property.
	StreetAddress interface{}
	// User profile property.
	Timezone interface{}
	// User profile property.
	Title interface{}
	// User profile property.
	UserType interface{}
	// User profile property.
	ZipCode interface{}
}

The set of arguments for constructing a User resource.

type UserState 

type UserState struct {
	// Administrator roles assigned to User.
	AdminRoles interface{}
	// User profile property.
	City interface{}
	// User profile property.
	CostCenter interface{}
	// User profile property.
	CountryCode interface{}
	// raw JSON containing all custom profile attributes.
	CustomProfileAttributes interface{}
	// User profile property.
	Department interface{}
	// User profile property.
	DisplayName interface{}
	// User profile property.
	Division interface{}
	// User profile property.
	Email interface{}
	// User profile property.
	EmployeeNumber interface{}
	// User's First Name, required by default.
	FirstName interface{}
	// User profile property.
	GroupMemberships interface{}
	// User profile property.
	HonorificPrefix interface{}
	// User profile property.
	HonorificSuffix interface{}
	// User's Last Name, required by default.
	LastName interface{}
	// User profile property.
	Locale interface{}
	// User profile property.
	Login interface{}
	// User profile property.
	Manager interface{}
	// User profile property.
	ManagerId interface{}
	// User profile property.
	MiddleName interface{}
	// User profile property.
	MobilePhone interface{}
	// User profile property.
	NickName interface{}
	// User profile property.
	Organization interface{}
	// User profile property.
	PostalAddress interface{}
	// User profile property.
	PreferredLanguage interface{}
	// User profile property.
	PrimaryPhone interface{}
	// User profile property.
	ProfileUrl interface{}
	// The raw status of the User in Okta - (status is mapped)
	RawStatus interface{}
	// User profile property.
	SecondEmail interface{}
	// User profile property.
	State interface{}
	// User profile property.
	Status interface{}
	// User profile property.
	StreetAddress interface{}
	// User profile property.
	Timezone interface{}
	// User profile property.
	Title interface{}
	// User profile property.
	UserType interface{}
	// User profile property.
	ZipCode interface{}
}

Input properties used for looking up and filtering User resources.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.