1. Docs
2. Reference
3. API
4. @pulumi/okta
5. types
6. output

Module types/output

namespace app

• AutoLoginUser
• BasicAuthUser
• BookmarkUser
• GetSamlAttributeStatement
• OAuthUser
• SamlAttributeStatement
• SamlUser
• SecurePasswordStoreUser
• SwaUser
• ThreeFieldUser
• UserSchemaArrayOneOf
• UserSchemaOneOf

namespace deprecated

• AuthLoginAppUser
• BookmarkAppUser
• MfaPolicyDuo
• MfaPolicyFidoU2f
• MfaPolicyFidoWebauthn
• MfaPolicyGoogleOtp
• MfaPolicyOktaCall
• MfaPolicyOktaOtp
• MfaPolicyOktaPassword
• MfaPolicyOktaPush
• MfaPolicyOktaQuestion
• MfaPolicyOktaSms
• MfaPolicyRsaToken
• MfaPolicySymantecVip
• MfaPolicyYubikeyToken
• OauthAppUser
• SamlAppAttributeStatement
• SamlAppUser
• SecurePasswordStoreAppUser
• SwaAppUser
• ThreeFieldAppUser

namespace inline

• HookAuth
• HookChannel
• HookHeader

namespace policy

• MfaDuo
• MfaFidoU2f
• MfaFidoWebauthn
• MfaGoogleOtp
• MfaOktaCall
• MfaOktaOtp
• MfaOktaPassword
• MfaOktaPush
• MfaOktaQuestion
• MfaOktaSms
• MfaRsaToken
• MfaSymantecVip
• MfaYubikeyToken
• RuleIdpDiscoveryAppExclude
• RuleIdpDiscoveryAppInclude
• RuleIdpDiscoveryPlatformInclude
• RuleIdpDiscoveryUserIdentifierPattern

namespace profile

• MappingMapping

namespace template

• EmailTranslation

namespace user

• GetUserSearch
• GetUsersSearch
• GetUsersUser
• SchemaArrayOneOf
• SchemaOneOf

namespace app

interface AutoLoginUser

interface AutoLoginUser

property id

id?: undefined | string;

property password

password?: undefined | string;

property scope

scope: string;

property username

username?: undefined | string;

interface BasicAuthUser

interface BasicAuthUser

property id

id?: undefined | string;

ID of the Application.

property password

password?: undefined | string;

property scope

scope: string;

property username

username?: undefined | string;

interface BookmarkUser

interface BookmarkUser

property id

id?: undefined | string;

ID of the Application.

property password

password?: undefined | string;

property scope

scope: string;

property username

username?: undefined | string;

interface GetSamlAttributeStatement

interface GetSamlAttributeStatement

property filterType

filterType?: undefined | string;

property filterValue

filterValue?: undefined | string;

property name

name: string;

name of application.

property namespace

namespace?: undefined | string;

property type

type?: undefined | string;

property values

values?: string[];

interface OAuthUser

interface OAuthUser

property id

id?: undefined | string;

property password

password?: undefined | string;

property scope

scope: string;

property username

username?: undefined | string;

interface SamlAttributeStatement

interface SamlAttributeStatement

property filterType

filterType?: undefined | string;

Type of group attribute filter.

property filterValue

filterValue?: undefined | string;

Filter value to use.

property name

name: string;

The name of the attribute statement.

property namespace

namespace?: undefined | string;

The attribute namespace. It can be set to "urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified", "urn:oasis:names:tc:SAML:2.0:attrname-format:uri", or "urn:oasis:names:tc:SAML:2.0:attrname-format:basic".

property type

type?: undefined | string;

The type of attribute statement value. Can be "EXPRESSION" or "GROUP".

property values

values?: string[];

Array of values to use.

interface SamlUser

interface SamlUser

property id

id?: undefined | string;

id of application.

property password

password?: undefined | string;

property scope

scope: string;

property username

username?: undefined | string;

interface SecurePasswordStoreUser

interface SecurePasswordStoreUser

property id

id?: undefined | string;

property password

password?: undefined | string;

property scope

scope: string;

property username

username?: undefined | string;

interface SwaUser

interface SwaUser

property id

id?: undefined | string;

property password

password?: undefined | string;

property scope

scope: string;

property username

username?: undefined | string;

interface ThreeFieldUser

interface ThreeFieldUser

property id

id?: undefined | string;

property password

password?: undefined | string;

property scope

scope: string;

property username

username?: undefined | string;

interface UserSchemaArrayOneOf

interface UserSchemaArrayOneOf

property const

const: string;

value mapping to member of enum.

property title

title: string;

display name for the enum value.

interface UserSchemaOneOf

interface UserSchemaOneOf

property const

const: string;

value mapping to member of enum.

property title

title: string;

display name for the enum value.

namespace deprecated

interface AuthLoginAppUser

interface AuthLoginAppUser

property id

id?: undefined | string;

property password

password?: undefined | string;

property scope

scope: string;

property username

username?: undefined | string;

interface BookmarkAppUser

interface BookmarkAppUser

property id

id?: undefined | string;

property password

password?: undefined | string;

property scope

scope: string;

property username

username?: undefined | string;

interface MfaPolicyDuo

interface MfaPolicyDuo

property consentType

consentType?: undefined | string;

property enroll

enroll?: undefined | string;

interface MfaPolicyFidoU2f

interface MfaPolicyFidoU2f

property consentType

consentType?: undefined | string;

property enroll

enroll?: undefined | string;

interface MfaPolicyFidoWebauthn

interface MfaPolicyFidoWebauthn

property consentType

consentType?: undefined | string;

property enroll

enroll?: undefined | string;

interface MfaPolicyGoogleOtp

interface MfaPolicyGoogleOtp

property consentType

consentType?: undefined | string;

property enroll

enroll?: undefined | string;

interface MfaPolicyOktaCall

interface MfaPolicyOktaCall

property consentType

consentType?: undefined | string;

property enroll

enroll?: undefined | string;

interface MfaPolicyOktaOtp

interface MfaPolicyOktaOtp

property consentType

consentType?: undefined | string;

property enroll

enroll?: undefined | string;

interface MfaPolicyOktaPassword

interface MfaPolicyOktaPassword

property consentType

consentType?: undefined | string;

property enroll

enroll?: undefined | string;

interface MfaPolicyOktaPush

interface MfaPolicyOktaPush

property consentType

consentType?: undefined | string;

property enroll

enroll?: undefined | string;

interface MfaPolicyOktaQuestion

interface MfaPolicyOktaQuestion

property consentType

consentType?: undefined | string;

property enroll

enroll?: undefined | string;

interface MfaPolicyOktaSms

interface MfaPolicyOktaSms

property consentType

consentType?: undefined | string;

property enroll

enroll?: undefined | string;

interface MfaPolicyRsaToken

interface MfaPolicyRsaToken

property consentType

consentType?: undefined | string;

property enroll

enroll?: undefined | string;

interface MfaPolicySymantecVip

interface MfaPolicySymantecVip

property consentType

consentType?: undefined | string;

property enroll

enroll?: undefined | string;

interface MfaPolicyYubikeyToken

interface MfaPolicyYubikeyToken

property consentType

consentType?: undefined | string;

property enroll

enroll?: undefined | string;

interface OauthAppUser

interface OauthAppUser

property id

id?: undefined | string;

property password

password?: undefined | string;

property scope

scope: string;

property username

username?: undefined | string;

interface SamlAppAttributeStatement

interface SamlAppAttributeStatement

property filterType

filterType?: undefined | string;

property filterValue

filterValue?: undefined | string;

property name

name: string;

property namespace

namespace?: undefined | string;

property type

type?: undefined | string;

property values

values?: string[];

interface SamlAppUser

interface SamlAppUser

property id

id?: undefined | string;

property password

password?: undefined | string;

property scope

scope: string;

property username

username?: undefined | string;

interface SecurePasswordStoreAppUser

interface SecurePasswordStoreAppUser

property id

id?: undefined | string;

property password

password?: undefined | string;

property scope

scope: string;

property username

username?: undefined | string;

interface SwaAppUser

interface SwaAppUser

property id

id?: undefined | string;

property password

password?: undefined | string;

property scope

scope: string;

property username

username?: undefined | string;

interface ThreeFieldAppUser

interface ThreeFieldAppUser

property id

id?: undefined | string;

property password

password?: undefined | string;

property scope

scope: string;

property username

username?: undefined | string;

namespace inline

interface HookAuth

interface HookAuth

property key

key?: undefined | string;

Key to use for authentication, usually the header name, for example "Authorization".

property type

type?: undefined | string;

The type of hook to trigger. Currently only "HTTP" is supported.

property value

value?: undefined | string;

Authentication secret.

interface HookChannel

interface HookChannel

property method

method?: undefined | string;

The request method to use. Default is "POST".

property type

type?: undefined | false | true;

The type of hook to trigger. Currently only "HTTP" is supported.

property uri

uri: string;

The URI the hook will hit.

property version

version: string;

The version of the endpoint.

interface HookHeader

interface HookHeader

property key

key?: undefined | string;

Key to use for authentication, usually the header name, for example "Authorization".

property value

value?: undefined | string;

Authentication secret.

namespace policy

interface MfaDuo

interface MfaDuo

property consentType

consentType?: undefined | string;

User consent type required before enrolling in the factor: "NONE" or "TERMS_OF_SERVICE". By default it is "NONE".

property enroll

enroll?: undefined | string;

Requirements for user initiated enrollment. Can be "NOT_ALLOWED", "OPTIONAL", or "REQUIRED". By default it is "OPTIONAL".

interface MfaFidoU2f

interface MfaFidoU2f

property consentType

consentType?: undefined | string;

User consent type required before enrolling in the factor: "NONE" or "TERMS_OF_SERVICE". By default it is "NONE".

property enroll

enroll?: undefined | string;

Requirements for user initiated enrollment. Can be "NOT_ALLOWED", "OPTIONAL", or "REQUIRED". By default it is "OPTIONAL".

interface MfaFidoWebauthn

interface MfaFidoWebauthn

property consentType

consentType?: undefined | string;

User consent type required before enrolling in the factor: "NONE" or "TERMS_OF_SERVICE". By default it is "NONE".

property enroll

enroll?: undefined | string;

Requirements for user initiated enrollment. Can be "NOT_ALLOWED", "OPTIONAL", or "REQUIRED". By default it is "OPTIONAL".

interface MfaGoogleOtp

interface MfaGoogleOtp

property consentType

consentType?: undefined | string;

User consent type required before enrolling in the factor: "NONE" or "TERMS_OF_SERVICE". By default it is "NONE".

property enroll

enroll?: undefined | string;

Requirements for user initiated enrollment. Can be "NOT_ALLOWED", "OPTIONAL", or "REQUIRED". By default it is "OPTIONAL".

interface MfaOktaCall

interface MfaOktaCall

property consentType

consentType?: undefined | string;

User consent type required before enrolling in the factor: "NONE" or "TERMS_OF_SERVICE". By default it is "NONE".

property enroll

enroll?: undefined | string;

Requirements for user initiated enrollment. Can be "NOT_ALLOWED", "OPTIONAL", or "REQUIRED". By default it is "OPTIONAL".

interface MfaOktaOtp

interface MfaOktaOtp

property consentType

consentType?: undefined | string;

User consent type required before enrolling in the factor: "NONE" or "TERMS_OF_SERVICE". By default it is "NONE".

property enroll

enroll?: undefined | string;

Requirements for user initiated enrollment. Can be "NOT_ALLOWED", "OPTIONAL", or "REQUIRED". By default it is "OPTIONAL".

interface MfaOktaPassword

interface MfaOktaPassword

property consentType

consentType?: undefined | string;

User consent type required before enrolling in the factor: "NONE" or "TERMS_OF_SERVICE". By default it is "NONE".

property enroll

enroll?: undefined | string;

Requirements for user initiated enrollment. Can be "NOT_ALLOWED", "OPTIONAL", or "REQUIRED". By default it is "OPTIONAL".

interface MfaOktaPush

interface MfaOktaPush

property consentType

consentType?: undefined | string;

User consent type required before enrolling in the factor: "NONE" or "TERMS_OF_SERVICE". By default it is "NONE".

property enroll

enroll?: undefined | string;

Requirements for user initiated enrollment. Can be "NOT_ALLOWED", "OPTIONAL", or "REQUIRED". By default it is "OPTIONAL".

interface MfaOktaQuestion

interface MfaOktaQuestion

property consentType

consentType?: undefined | string;

User consent type required before enrolling in the factor: "NONE" or "TERMS_OF_SERVICE". By default it is "NONE".

property enroll

enroll?: undefined | string;

Requirements for user initiated enrollment. Can be "NOT_ALLOWED", "OPTIONAL", or "REQUIRED". By default it is "OPTIONAL".

interface MfaOktaSms

interface MfaOktaSms

property consentType

consentType?: undefined | string;

User consent type required before enrolling in the factor: "NONE" or "TERMS_OF_SERVICE". By default it is "NONE".

property enroll

enroll?: undefined | string;

Requirements for user initiated enrollment. Can be "NOT_ALLOWED", "OPTIONAL", or "REQUIRED". By default it is "OPTIONAL".

interface MfaRsaToken

interface MfaRsaToken

property consentType

consentType?: undefined | string;

User consent type required before enrolling in the factor: "NONE" or "TERMS_OF_SERVICE". By default it is "NONE".

property enroll

enroll?: undefined | string;

Requirements for user initiated enrollment. Can be "NOT_ALLOWED", "OPTIONAL", or "REQUIRED". By default it is "OPTIONAL".

interface MfaSymantecVip

interface MfaSymantecVip

property consentType

consentType?: undefined | string;

User consent type required before enrolling in the factor: "NONE" or "TERMS_OF_SERVICE". By default it is "NONE".

property enroll

enroll?: undefined | string;

Requirements for user initiated enrollment. Can be "NOT_ALLOWED", "OPTIONAL", or "REQUIRED". By default it is "OPTIONAL".

interface MfaYubikeyToken

interface MfaYubikeyToken

property consentType

consentType?: undefined | string;

User consent type required before enrolling in the factor: "NONE" or "TERMS_OF_SERVICE". By default it is "NONE".

property enroll

enroll?: undefined | string;

Requirements for user initiated enrollment. Can be "NOT_ALLOWED", "OPTIONAL", or "REQUIRED". By default it is "OPTIONAL".

interface RuleIdpDiscoveryAppExclude

interface RuleIdpDiscoveryAppExclude

property id

id?: undefined | string;

ID of the Rule.

property name

name?: undefined | string;

Policy Rule Name.

property type

type?: undefined | string;

interface RuleIdpDiscoveryAppInclude

interface RuleIdpDiscoveryAppInclude

property id

id?: undefined | string;

ID of the Rule.

property name

name?: undefined | string;

Policy Rule Name.

property type

type?: undefined | string;

interface RuleIdpDiscoveryPlatformInclude

interface RuleIdpDiscoveryPlatformInclude

property osExpression

osExpression?: undefined | string;

property osType

osType?: undefined | string;

property type

type?: undefined | string;

interface RuleIdpDiscoveryUserIdentifierPattern

interface RuleIdpDiscoveryUserIdentifierPattern

property matchType

matchType?: undefined | string;

property value

value?: undefined | string;

namespace profile

interface MappingMapping

interface MappingMapping

property expression

expression: string;

property id

id: string;

property pushStatus

pushStatus?: undefined | string;

namespace template

interface EmailTranslation

interface EmailTranslation

property language

language: string;

The language to map tthe template to.

property subject

subject: string;

The email subject line.

property template

template: string;

The email body.

namespace user

interface GetUserSearch

interface GetUserSearch

property comparison

comparison?: undefined | string;

Comparison to use.

property name

name: string;

Name of property to search against.

property value

value: string;

Value to compare with.

interface GetUsersSearch

interface GetUsersSearch

property comparison

comparison?: undefined | string;

Comparison to use.

property name

name: string;

Name of property to search against.

property value

value: string;

Value to compare with.

interface GetUsersUser

interface GetUsersUser

property adminRoles

adminRoles: string[];

Administrator roles assigned to user.

property city

city: string;

user profile property.

property costCenter

costCenter: string;

user profile property.

property countryCode

countryCode: string;

user profile property.

property customProfileAttributes

customProfileAttributes: string;

raw JSON containing all custom profile attributes.

property department

department: string;

user profile property.

property displayName

displayName: string;

user profile property.

property division

division: string;

user profile property.

property email

email: string;

user profile property.

property employeeNumber

employeeNumber: string;

user profile property.

property firstName

firstName: string;

user profile property.

property groupMemberships

groupMemberships: string[];

user profile property.

property honorificPrefix

honorificPrefix: string;

user profile property.

property honorificSuffix

honorificSuffix: string;

user profile property.

property lastName

lastName: string;

user profile property.

property locale

locale: string;

user profile property.

property login

login: string;

user profile property.

property manager

manager: string;

user profile property.

property managerId

managerId: string;

user profile property.

property middleName

middleName: string;

user profile property.

property mobilePhone

mobilePhone: string;

user profile property.

property nickName

nickName: string;

user profile property.

property organization

organization: string;

user profile property.

property postalAddress

postalAddress: string;

user profile property.

property preferredLanguage

preferredLanguage: string;

user profile property.

property primaryPhone

primaryPhone: string;

user profile property.

property profileUrl

profileUrl: string;

user profile property.

property secondEmail

secondEmail: string;

user profile property.

property state

state: string;

user profile property.

property status

status: string;

user profile property.

property streetAddress

streetAddress: string;

user profile property.

property timezone

timezone: string;

user profile property.

property title

title: string;

user profile property.

property userType

userType: string;

user profile property.

property zipCode

zipCode: string;

user profile property.

interface SchemaArrayOneOf

interface SchemaArrayOneOf

property const

const: string;

value mapping to member of enum.

property title

title: string;

display name for the enum value.

interface SchemaOneOf

interface SchemaOneOf

property const

const: string;

value mapping to member of enum.

property title

title: string;

display name for the enum value.