Okta.PowerShell.Okta.PowerShell\Api.OktaCustomizationApi

All URIs are relative to https://subdomain.okta.com

Method	HTTP request	Description
New-OktaBrand	POST /api/v1/brands	Create a Brand
New-OktaEmailCustomization	POST /api/v1/brands/{brandId}/templates/email/{templateName}/customizations	Create an Email Customization
Invoke-OktaDeleteAllCustomizations	DELETE /api/v1/brands/{brandId}/templates/email/{templateName}/customizations	Delete all Email Customizations
Invoke-OktaDeleteBrand	DELETE /api/v1/brands/{brandId}	Delete a brand
Invoke-OktaDeleteBrandThemeBackgroundImage	DELETE /api/v1/brands/{brandId}/themes/{themeId}/background-image	Delete the Background Image
Invoke-OktaDeleteBrandThemeFavicon	DELETE /api/v1/brands/{brandId}/themes/{themeId}/favicon	Delete the Favicon
Invoke-OktaDeleteBrandThemeLogo	DELETE /api/v1/brands/{brandId}/themes/{themeId}/logo	Delete the Logo
Invoke-OktaDeleteEmailCustomization	DELETE /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}	Delete an Email Customization
Get-OktaBrand	GET /api/v1/brands/{brandId}	Retrieve a Brand
Get-OktaBrandDomains	GET /api/v1/brands/{brandId}/domains	List all Domains associated with a Brand
Get-OktaBrandTheme	GET /api/v1/brands/{brandId}/themes/{themeId}	Retrieve a Theme
Get-OktaCustomizationPreview	GET /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}/preview	Preview an Email Customization
Get-OktaEmailCustomization	GET /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}	Retrieve an Email Customization
Get-OktaEmailDefaultContent	GET /api/v1/brands/{brandId}/templates/email/{templateName}/default-content	Retrieve an Email Template Default Content
Get-OktaEmailDefaultPreview	GET /api/v1/brands/{brandId}/templates/email/{templateName}/default-content/preview	Preview the Email Template Default Content
Get-OktaEmailSettings	GET /api/v1/brands/{brandId}/templates/email/{templateName}/settings	Retrieve the Email Template Settings
Get-OktaEmailTemplate	GET /api/v1/brands/{brandId}/templates/email/{templateName}	Retrieve an Email Template
Invoke-OktaLinkBrandDomain	POST /api/v1/brands/{brandId}/domains	Link a Brand to a Domain
Invoke-OktaListAllSignInWidgetVersions	GET /api/v1/brands/{brandId}/pages/sign-in/widget-versions	List all Sign-in Widget Versions
Invoke-OktaListBrandThemes	GET /api/v1/brands/{brandId}/themes	List all Themes
Invoke-OktaListBrands	GET /api/v1/brands	List all Brands
Invoke-OktaListEmailCustomizations	GET /api/v1/brands/{brandId}/templates/email/{templateName}/customizations	List all Email Customizations
Invoke-OktaListEmailTemplates	GET /api/v1/brands/{brandId}/templates/email	List all Email Templates
Invoke-OktaReplaceCustomizedErrorPage	PUT /api/v1/brands/{brandId}/pages/error/customized	Replace the Customized Error Page
Invoke-OktaReplaceCustomizedSignInPage	PUT /api/v1/brands/{brandId}/pages/sign-in/customized	Replace the Customized Sign-in Page
Invoke-OktaReplacePreviewErrorPage	PUT /api/v1/brands/{brandId}/pages/error/preview	Replace the Preview Error Page
Invoke-OktaReplacePreviewSignInPage	PUT /api/v1/brands/{brandId}/pages/sign-in/preview	Replace the Preview Sign-in Page
Invoke-OktaReplaceSignOutPageSettings	PUT /api/v1/brands/{brandId}/pages/sign-out/customized	Replace the Sign-out Page Settings
Reset-OktaCustomizedErrorPage	DELETE /api/v1/brands/{brandId}/pages/error/customized	Reset the Customized Error Page
Reset-OktaCustomizedSignInPage	DELETE /api/v1/brands/{brandId}/pages/sign-in/customized	Reset the Customized Sign-in Page
Reset-OktaPreviewErrorPage	DELETE /api/v1/brands/{brandId}/pages/error/preview	Reset the Preview Error Page
Reset-OktaPreviewSignInPage	DELETE /api/v1/brands/{brandId}/pages/sign-in/preview	Reset the Preview Sign-in Page
Invoke-OktaRetrieveCustomizedErrorPage	GET /api/v1/brands/{brandId}/pages/error/customized	Retrieve the Customized Error Page
Invoke-OktaRetrieveCustomizedSignInPage	GET /api/v1/brands/{brandId}/pages/sign-in/customized	Retrieve the Customized Sign-in Page
Invoke-OktaRetrieveDefaultErrorPage	GET /api/v1/brands/{brandId}/pages/error/default	Retrieve the Default Error Page
Invoke-OktaRetrieveDefaultSignInPage	GET /api/v1/brands/{brandId}/pages/sign-in/default	Retrieve the Default Sign-in Page
Invoke-OktaRetrieveErrorPage	GET /api/v1/brands/{brandId}/pages/error	Retrieve the Error Page
Invoke-OktaRetrievePreviewErrorPage	GET /api/v1/brands/{brandId}/pages/error/preview	Retrieve the Preview Error Page Preview
Invoke-OktaRetrievePreviewSignInPage	GET /api/v1/brands/{brandId}/pages/sign-in/preview	Retrieve the Preview Sign-in Page Preview
Invoke-OktaRetrieveSignInPage	GET /api/v1/brands/{brandId}/pages/sign-in	Retrieve the Sign-in Page
Invoke-OktaRetrieveSignOutPageSettings	GET /api/v1/brands/{brandId}/pages/sign-out/customized	Retrieve the Sign-out Page Settings
Send-OktaTestEmail	POST /api/v1/brands/{brandId}/templates/email/{templateName}/test	Send a Test Email
Invoke-OktaUnlinkBrandDomain	DELETE /api/v1/brands/{brandId}/domains/{domainId}	Unlink a Brand from a Domain
Update-OktaBrand	PUT /api/v1/brands/{brandId}	Replace a Brand
Update-OktaBrandTheme	PUT /api/v1/brands/{brandId}/themes/{themeId}	Replace a Theme
Update-OktaEmailCustomization	PUT /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}	Replace an Email Customization
Update-OktaEmailSettings	PUT /api/v1/brands/{brandId}/templates/email/{templateName}/settings	Replace the Email Template Settings
Invoke-OktaUploadBrandThemeBackgroundImage	POST /api/v1/brands/{brandId}/themes/{themeId}/background-image	Upload the Background Image
Invoke-OktaUploadBrandThemeFavicon	POST /api/v1/brands/{brandId}/themes/{themeId}/favicon	Upload the Favicon
Invoke-OktaUploadBrandThemeLogo	POST /api/v1/brands/{brandId}/themes/{themeId}/logo	Upload the Logo

New-OktaBrand

Brand New-OktaBrand
[-CreateBrandRequest]

Create a Brand

Create new brand in your org

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$CreateBrandRequest = Initialize-CreateBrandRequest -Name "MyName" # CreateBrandRequest |  (optional)

# Create a Brand
try {
    $Result = New-OktaBrand -CreateBrandRequest $CreateBrandRequest
} catch {
    Write-Host ("Exception occurred when calling New-OktaBrand: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
CreateBrandRequest	CreateBrandRequest		[optional]

Return type

Brand (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

New-OktaEmailCustomization

EmailCustomization New-OktaEmailCustomization
        [-BrandId]
        [-TemplateName]
        [-Instance]

Create an Email Customization

Creates a new email customization.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$TemplateName = "MyTemplateName" # String | The name of the email template.
$HrefObjectHints = Initialize-HrefObjectHints -Allow "DELETE"
$HrefObject = Initialize-HrefObject -Hints $HrefObjectHints -Href "MyHref" -Name "MyName" -Type "MyType"

$EmailCustomizationAllOfLinks = Initialize-EmailCustomizationAllOfLinks -Self $HrefObject -Template $HrefObject -Preview $HrefObject -Test $HrefObject

$EmailCustomization = Initialize-EmailCustomization -Body "MyBody" -Subject "MySubject" -Created (Get-Date) -Id "MyId" -IsDefault $false -Language "MyLanguage" -LastUpdated (Get-Date) -Links $EmailCustomizationAllOfLinks # EmailCustomization |  (optional)

# Create an Email Customization
try {
    $Result = New-OktaEmailCustomization -BrandId $BrandId -TemplateName $TemplateName -Instance $Instance
} catch {
    Write-Host ("Exception occurred when calling New-OktaEmailCustomization: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.
TemplateName	String	The name of the email template.
Instance	EmailCustomization		[optional]

Return type

EmailCustomization (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaDeleteAllCustomizations

void Invoke-OktaDeleteAllCustomizations
[-BrandId]
[-TemplateName]

Delete all Email Customizations

Deletes all customizations for an email template.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$TemplateName = "MyTemplateName" # String | The name of the email template.

# Delete all Email Customizations
try {
    $Result = Invoke-OktaDeleteAllCustomizations -BrandId $BrandId -TemplateName $TemplateName
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaDeleteAllCustomizations: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.
TemplateName	String	The name of the email template.

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaDeleteBrand

void Invoke-OktaDeleteBrand
[-BrandId]

Delete a brand

Deletes a brand by its unique identifier.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.

# Delete a brand
try {
    $Result = Invoke-OktaDeleteBrand -BrandId $BrandId
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaDeleteBrand: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaDeleteBrandThemeBackgroundImage

void Invoke-OktaDeleteBrandThemeBackgroundImage
[-BrandId]
[-ThemeId]

Delete the Background Image

Deletes a Theme background image.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$ThemeId = "MyThemeId" # String | The ID of the theme.

# Delete the Background Image
try {
    $Result = Invoke-OktaDeleteBrandThemeBackgroundImage -BrandId $BrandId -ThemeId $ThemeId
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaDeleteBrandThemeBackgroundImage: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.
ThemeId	String	The ID of the theme.

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaDeleteBrandThemeFavicon

void Invoke-OktaDeleteBrandThemeFavicon
[-BrandId]
[-ThemeId]

Delete the Favicon

Deletes a Theme favicon. The theme will use the default Okta favicon.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$ThemeId = "MyThemeId" # String | The ID of the theme.

# Delete the Favicon
try {
    $Result = Invoke-OktaDeleteBrandThemeFavicon -BrandId $BrandId -ThemeId $ThemeId
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaDeleteBrandThemeFavicon: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.
ThemeId	String	The ID of the theme.

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaDeleteBrandThemeLogo

void Invoke-OktaDeleteBrandThemeLogo
[-BrandId]
[-ThemeId]

Delete the Logo

Deletes a Theme logo. The theme will use the default Okta logo.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$ThemeId = "MyThemeId" # String | The ID of the theme.

# Delete the Logo
try {
    $Result = Invoke-OktaDeleteBrandThemeLogo -BrandId $BrandId -ThemeId $ThemeId
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaDeleteBrandThemeLogo: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.
ThemeId	String	The ID of the theme.

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaDeleteEmailCustomization

void Invoke-OktaDeleteEmailCustomization
        [-BrandId]
        [-TemplateName]
        [-CustomizationId]

Delete an Email Customization

Deletes an email customization by its unique identifier.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$TemplateName = "MyTemplateName" # String | The name of the email template.
$CustomizationId = "MyCustomizationId" # String | The ID of the email customization.

# Delete an Email Customization
try {
    $Result = Invoke-OktaDeleteEmailCustomization -BrandId $BrandId -TemplateName $TemplateName -CustomizationId $CustomizationId
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaDeleteEmailCustomization: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description
BrandId	String	The ID of the brand.
TemplateName	String	The name of the email template.
CustomizationId	String	The ID of the email customization.

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Get-OktaBrand

Brand Get-OktaBrand
[-BrandId]

Retrieve a Brand

Fetches a brand by brandId

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.

# Retrieve a Brand
try {
    $Result = Get-OktaBrand -BrandId $BrandId
} catch {
    Write-Host ("Exception occurred when calling Get-OktaBrand: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.

Return type

Brand (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Get-OktaBrandDomains

DomainResponse[] Get-OktaBrandDomains
[-BrandId]

List all Domains associated with a Brand

List all domains associated with a brand by brandId

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.

# List all Domains associated with a Brand
try {
    $Result = Get-OktaBrandDomains -BrandId $BrandId
} catch {
    Write-Host ("Exception occurred when calling Get-OktaBrandDomains: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.

Return type

DomainResponse[] (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Get-OktaBrandTheme

ThemeResponse Get-OktaBrandTheme
[-BrandId]
[-ThemeId]

Retrieve a Theme

Fetches a theme for a brand

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$ThemeId = "MyThemeId" # String | The ID of the theme.

# Retrieve a Theme
try {
    $Result = Get-OktaBrandTheme -BrandId $BrandId -ThemeId $ThemeId
} catch {
    Write-Host ("Exception occurred when calling Get-OktaBrandTheme: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.
ThemeId	String	The ID of the theme.

Return type

ThemeResponse (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Get-OktaCustomizationPreview

EmailPreview Get-OktaCustomizationPreview
        [-BrandId]
        [-TemplateName]
        [-CustomizationId]

Preview an Email Customization

Generates a preview of an email customization. All variable references (e.g., ${user.profile.firstName}) are populated using the current user's context.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$TemplateName = "MyTemplateName" # String | The name of the email template.
$CustomizationId = "MyCustomizationId" # String | The ID of the email customization.

# Preview an Email Customization
try {
    $Result = Get-OktaCustomizationPreview -BrandId $BrandId -TemplateName $TemplateName -CustomizationId $CustomizationId
} catch {
    Write-Host ("Exception occurred when calling Get-OktaCustomizationPreview: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description
BrandId	String	The ID of the brand.
TemplateName	String	The name of the email template.
CustomizationId	String	The ID of the email customization.

Return type

EmailPreview (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Get-OktaEmailCustomization

EmailCustomization Get-OktaEmailCustomization
        [-BrandId]
        [-TemplateName]
        [-CustomizationId]

Retrieve an Email Customization

Gets an email customization by its unique identifier.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$TemplateName = "MyTemplateName" # String | The name of the email template.
$CustomizationId = "MyCustomizationId" # String | The ID of the email customization.

# Retrieve an Email Customization
try {
    $Result = Get-OktaEmailCustomization -BrandId $BrandId -TemplateName $TemplateName -CustomizationId $CustomizationId
} catch {
    Write-Host ("Exception occurred when calling Get-OktaEmailCustomization: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description
BrandId	String	The ID of the brand.
TemplateName	String	The name of the email template.
CustomizationId	String	The ID of the email customization.

Return type

EmailCustomization (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Get-OktaEmailDefaultContent

EmailDefaultContent Get-OktaEmailDefaultContent
        [-BrandId]
        [-TemplateName]
        [-Language]

Retrieve an Email Template Default Content

Gets an email template's default content.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$TemplateName = "MyTemplateName" # String | The name of the email template.
$Language = "MyLanguage" # String | The language to use for the email. Defaults to the current user's language if unspecified. (optional)

# Retrieve an Email Template Default Content
try {
    $Result = Get-OktaEmailDefaultContent -BrandId $BrandId -TemplateName $TemplateName -Language $Language
} catch {
    Write-Host ("Exception occurred when calling Get-OktaEmailDefaultContent: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.
TemplateName	String	The name of the email template.
Language	String	The language to use for the email. Defaults to the current user's language if unspecified.	[optional]

Return type

EmailDefaultContent (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Get-OktaEmailDefaultPreview

EmailPreview Get-OktaEmailDefaultPreview
        [-BrandId]
        [-TemplateName]
        [-Language]

Preview the Email Template Default Content

Generates a preview of an email template's default content. All variable references (e.g., ${user.profile.firstName}) are populated using the current user's context.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$TemplateName = "MyTemplateName" # String | The name of the email template.
$Language = "MyLanguage" # String | The language to use for the email. Defaults to the current user's language if unspecified. (optional)

# Preview the Email Template Default Content
try {
    $Result = Get-OktaEmailDefaultPreview -BrandId $BrandId -TemplateName $TemplateName -Language $Language
} catch {
    Write-Host ("Exception occurred when calling Get-OktaEmailDefaultPreview: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.
TemplateName	String	The name of the email template.
Language	String	The language to use for the email. Defaults to the current user's language if unspecified.	[optional]

Return type

EmailPreview (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Get-OktaEmailSettings

EmailSettings Get-OktaEmailSettings
[-BrandId]
[-TemplateName]

Retrieve the Email Template Settings

Gets an email template's settings.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$TemplateName = "MyTemplateName" # String | The name of the email template.

# Retrieve the Email Template Settings
try {
    $Result = Get-OktaEmailSettings -BrandId $BrandId -TemplateName $TemplateName
} catch {
    Write-Host ("Exception occurred when calling Get-OktaEmailSettings: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.
TemplateName	String	The name of the email template.

Return type

EmailSettings (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Get-OktaEmailTemplate

EmailTemplate Get-OktaEmailTemplate
        [-BrandId]
        [-TemplateName]
        [-Expand] <String[]>

Retrieve an Email Template

Gets the details of an email template by name.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$TemplateName = "MyTemplateName" # String | The name of the email template.
$Expand = "settings" # String[] | Specifies additional metadata to be included in the response. (optional)

# Retrieve an Email Template
try {
    $Result = Get-OktaEmailTemplate -BrandId $BrandId -TemplateName $TemplateName -Expand $Expand
} catch {
    Write-Host ("Exception occurred when calling Get-OktaEmailTemplate: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.
TemplateName	String	The name of the email template.
Expand	String[]	Specifies additional metadata to be included in the response.	[optional]

Return type

EmailTemplate (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaLinkBrandDomain

BrandDomain Invoke-OktaLinkBrandDomain
[-BrandId]
[-CreateBrandDomainRequest]

Link a Brand to a Domain

Link a Brand to a Domain by domainId

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$CreateBrandDomainRequest = Initialize-CreateBrandDomainRequest -DomainId "MyDomainId" # CreateBrandDomainRequest |  (optional)

# Link a Brand to a Domain
try {
    $Result = Invoke-OktaLinkBrandDomain -BrandId $BrandId -CreateBrandDomainRequest $CreateBrandDomainRequest
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaLinkBrandDomain: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.
CreateBrandDomainRequest	CreateBrandDomainRequest		[optional]

Return type

BrandDomain (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaListAllSignInWidgetVersions

String[] Invoke-OktaListAllSignInWidgetVersions
[-BrandId]

List all Sign-in Widget Versions

List all sign-in widget versions.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.

# List all Sign-in Widget Versions
try {
    $Result = Invoke-OktaListAllSignInWidgetVersions -BrandId $BrandId
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaListAllSignInWidgetVersions: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.

Return type

String[]

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaListBrandThemes

ThemeResponse[] Invoke-OktaListBrandThemes
[-BrandId]

List all Themes

List all the themes in your brand

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.

# List all Themes
try {
    $Result = Invoke-OktaListBrandThemes -BrandId $BrandId
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaListBrandThemes: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.

Return type

ThemeResponse[] (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaListBrands

Brand[] Invoke-OktaListBrands

List all Brands

List all the brands in your org.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read


# List all Brands
try {
    $Result = Invoke-OktaListBrands
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaListBrands: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

This endpoint does not need any parameter.

Return type

Brand[] (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaListEmailCustomizations

EmailCustomization[] Invoke-OktaListEmailCustomizations
        [-BrandId]
        [-TemplateName]
        [-After]
        [-Limit] <System.Nullable[Int32]>

List all Email Customizations

Lists all customizations of an email template.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$TemplateName = "MyTemplateName" # String | The name of the email template.
$After = "MyAfter" # String | The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information. (optional)
$Limit = 56 # Int32 | A limit on the number of objects to return. (optional) (default to 20)

# List all Email Customizations
try {
    $Result = Invoke-OktaListEmailCustomizations -BrandId $BrandId -TemplateName $TemplateName -After $After -Limit $Limit
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaListEmailCustomizations: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.
TemplateName	String	The name of the email template.
After	String	The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See Pagination for more information.	[optional]
Limit	Int32	A limit on the number of objects to return.	[optional] [default to 20]

Return type

EmailCustomization[] (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaListEmailTemplates

EmailTemplate[] Invoke-OktaListEmailTemplates
        [-BrandId]
        [-After]
        [-Limit] <System.Nullable[Int32]>
        [-Expand] <String[]>

List all Email Templates

Lists all email templates.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$After = "MyAfter" # String | The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information. (optional)
$Limit = 56 # Int32 | A limit on the number of objects to return. (optional) (default to 20)
$Expand = "settings" # String[] | Specifies additional metadata to be included in the response. (optional)

# List all Email Templates
try {
    $Result = Invoke-OktaListEmailTemplates -BrandId $BrandId -After $After -Limit $Limit -Expand $Expand
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaListEmailTemplates: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.
After	String	The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See Pagination for more information.	[optional]
Limit	Int32	A limit on the number of objects to return.	[optional] [default to 20]
Expand	String[]	Specifies additional metadata to be included in the response.	[optional]

Return type

EmailTemplate[] (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaReplaceCustomizedErrorPage

CustomizablePage Invoke-OktaReplaceCustomizedErrorPage
[-BrandId]
[-CustomizablePage]

Replace the Customized Error Page

Replaces the customized error page.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$CustomizablePage = Initialize-CustomizablePage -PageContent "MyPageContent" # CustomizablePage | 

# Replace the Customized Error Page
try {
    $Result = Invoke-OktaReplaceCustomizedErrorPage -BrandId $BrandId -CustomizablePage $CustomizablePage
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaReplaceCustomizedErrorPage: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.
CustomizablePage	CustomizablePage

Return type

CustomizablePage (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaReplaceCustomizedSignInPage

SignInPage Invoke-OktaReplaceCustomizedSignInPage
[-BrandId]
[-SignInPage]

Replace the Customized Sign-in Page

Replaces the customized sign-in page.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$SignInPageAllOfWidgetCustomizations = Initialize-SignInPageAllOfWidgetCustomizations -SignInLabel "MySignInLabel" -UsernameLabel "MyUsernameLabel" -UsernameInfoTip "MyUsernameInfoTip" -PasswordLabel "MyPasswordLabel" -PasswordInfoTip "MyPasswordInfoTip" -ShowPasswordVisibilityToggle $false -ShowUserIdentifier $false -ForgotPasswordLabel "MyForgotPasswordLabel" -ForgotPasswordUrl "MyForgotPasswordUrl" -UnlockAccountLabel "MyUnlockAccountLabel" -UnlockAccountUrl "MyUnlockAccountUrl" -HelpLabel "MyHelpLabel" -HelpUrl "MyHelpUrl" -CustomLink1Label "MyCustomLink1Label" -CustomLink1Url "MyCustomLink1Url" -CustomLink2Label "MyCustomLink2Label" -CustomLink2Url "MyCustomLink2Url" -AuthenticatorPageCustomLinkLabel "MyAuthenticatorPageCustomLinkLabel" -AuthenticatorPageCustomLinkUrl "MyAuthenticatorPageCustomLinkUrl" -ClassicRecoveryFlowEmailOrUsernameLabel "MyClassicRecoveryFlowEmailOrUsernameLabel"
$SignInPage = Initialize-SignInPage -PageContent "MyPageContent" -WidgetCustomizations $SignInPageAllOfWidgetCustomizations -WidgetVersion "MyWidgetVersion" # SignInPage | 

# Replace the Customized Sign-in Page
try {
    $Result = Invoke-OktaReplaceCustomizedSignInPage -BrandId $BrandId -SignInPage $SignInPage
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaReplaceCustomizedSignInPage: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.
SignInPage	SignInPage

Return type

SignInPage (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaReplacePreviewErrorPage

CustomizablePage Invoke-OktaReplacePreviewErrorPage
[-BrandId]
[-CustomizablePage]

Replace the Preview Error Page

Replace the preview error page.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$CustomizablePage = Initialize-CustomizablePage -PageContent "MyPageContent" # CustomizablePage | 

# Replace the Preview Error Page
try {
    $Result = Invoke-OktaReplacePreviewErrorPage -BrandId $BrandId -CustomizablePage $CustomizablePage
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaReplacePreviewErrorPage: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.
CustomizablePage	CustomizablePage

Return type

CustomizablePage (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaReplacePreviewSignInPage

SignInPage Invoke-OktaReplacePreviewSignInPage
[-BrandId]
[-SignInPage]

Replace the Preview Sign-in Page

Replace the preview sign-in page.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$SignInPageAllOfWidgetCustomizations = Initialize-SignInPageAllOfWidgetCustomizations -SignInLabel "MySignInLabel" -UsernameLabel "MyUsernameLabel" -UsernameInfoTip "MyUsernameInfoTip" -PasswordLabel "MyPasswordLabel" -PasswordInfoTip "MyPasswordInfoTip" -ShowPasswordVisibilityToggle $false -ShowUserIdentifier $false -ForgotPasswordLabel "MyForgotPasswordLabel" -ForgotPasswordUrl "MyForgotPasswordUrl" -UnlockAccountLabel "MyUnlockAccountLabel" -UnlockAccountUrl "MyUnlockAccountUrl" -HelpLabel "MyHelpLabel" -HelpUrl "MyHelpUrl" -CustomLink1Label "MyCustomLink1Label" -CustomLink1Url "MyCustomLink1Url" -CustomLink2Label "MyCustomLink2Label" -CustomLink2Url "MyCustomLink2Url" -AuthenticatorPageCustomLinkLabel "MyAuthenticatorPageCustomLinkLabel" -AuthenticatorPageCustomLinkUrl "MyAuthenticatorPageCustomLinkUrl" -ClassicRecoveryFlowEmailOrUsernameLabel "MyClassicRecoveryFlowEmailOrUsernameLabel"
$SignInPage = Initialize-SignInPage -PageContent "MyPageContent" -WidgetCustomizations $SignInPageAllOfWidgetCustomizations -WidgetVersion "MyWidgetVersion" # SignInPage | 

# Replace the Preview Sign-in Page
try {
    $Result = Invoke-OktaReplacePreviewSignInPage -BrandId $BrandId -SignInPage $SignInPage
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaReplacePreviewSignInPage: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.
SignInPage	SignInPage

Return type

SignInPage (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaReplaceSignOutPageSettings

HostedPage Invoke-OktaReplaceSignOutPageSettings
[-BrandId]
[-HostedPage]

Replace the Sign-out Page Settings

Replaces the sign-out page settings.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$HostedPage = Initialize-HostedPage -Type "EXTERNALLY_HOSTED" -Url "MyUrl" # HostedPage | 

# Replace the Sign-out Page Settings
try {
    $Result = Invoke-OktaReplaceSignOutPageSettings -BrandId $BrandId -HostedPage $HostedPage
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaReplaceSignOutPageSettings: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.
HostedPage	HostedPage

Return type

HostedPage (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Reset-OktaCustomizedErrorPage

void Reset-OktaCustomizedErrorPage
[-BrandId]

Reset the Customized Error Page

Resets the customized error page.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.

# Reset the Customized Error Page
try {
    $Result = Reset-OktaCustomizedErrorPage -BrandId $BrandId
} catch {
    Write-Host ("Exception occurred when calling Reset-OktaCustomizedErrorPage: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Reset-OktaCustomizedSignInPage

void Reset-OktaCustomizedSignInPage
[-BrandId]

Reset the Customized Sign-in Page

Reset the customized sign-in page.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.

# Reset the Customized Sign-in Page
try {
    $Result = Reset-OktaCustomizedSignInPage -BrandId $BrandId
} catch {
    Write-Host ("Exception occurred when calling Reset-OktaCustomizedSignInPage: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Reset-OktaPreviewErrorPage

void Reset-OktaPreviewErrorPage
[-BrandId]

Reset the Preview Error Page

Reset the preview error page.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.

# Reset the Preview Error Page
try {
    $Result = Reset-OktaPreviewErrorPage -BrandId $BrandId
} catch {
    Write-Host ("Exception occurred when calling Reset-OktaPreviewErrorPage: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Reset-OktaPreviewSignInPage

void Reset-OktaPreviewSignInPage
[-BrandId]

Reset the Preview Sign-in Page

Reset the preview sign-in page.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.

# Reset the Preview Sign-in Page
try {
    $Result = Reset-OktaPreviewSignInPage -BrandId $BrandId
} catch {
    Write-Host ("Exception occurred when calling Reset-OktaPreviewSignInPage: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaRetrieveCustomizedErrorPage

CustomizablePage Invoke-OktaRetrieveCustomizedErrorPage
[-BrandId]

Retrieve the Customized Error Page

Retrieves the customized error page.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.

# Retrieve the Customized Error Page
try {
    $Result = Invoke-OktaRetrieveCustomizedErrorPage -BrandId $BrandId
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaRetrieveCustomizedErrorPage: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.

Return type

CustomizablePage (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaRetrieveCustomizedSignInPage

SignInPage Invoke-OktaRetrieveCustomizedSignInPage
[-BrandId]

Retrieve the Customized Sign-in Page

Retrieves the customized sign-in page.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.

# Retrieve the Customized Sign-in Page
try {
    $Result = Invoke-OktaRetrieveCustomizedSignInPage -BrandId $BrandId
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaRetrieveCustomizedSignInPage: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.

Return type

SignInPage (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaRetrieveDefaultErrorPage

CustomizablePage Invoke-OktaRetrieveDefaultErrorPage
[-BrandId]

Retrieve the Default Error Page

Retrieves the default error page.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.

# Retrieve the Default Error Page
try {
    $Result = Invoke-OktaRetrieveDefaultErrorPage -BrandId $BrandId
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaRetrieveDefaultErrorPage: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.

Return type

CustomizablePage (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaRetrieveDefaultSignInPage

SignInPage Invoke-OktaRetrieveDefaultSignInPage
[-BrandId]

Retrieve the Default Sign-in Page

Retrieves the default sign-in page.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.

# Retrieve the Default Sign-in Page
try {
    $Result = Invoke-OktaRetrieveDefaultSignInPage -BrandId $BrandId
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaRetrieveDefaultSignInPage: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.

Return type

SignInPage (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaRetrieveErrorPage

PageRoot Invoke-OktaRetrieveErrorPage
[-BrandId]
[-Expand] <String[]>

Retrieve the Error Page

Retrieves the error page.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$Expand = "default" # String[] | Specifies additional metadata to be included in the response. (optional)

# Retrieve the Error Page
try {
    $Result = Invoke-OktaRetrieveErrorPage -BrandId $BrandId -Expand $Expand
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaRetrieveErrorPage: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.
Expand	String[]	Specifies additional metadata to be included in the response.	[optional]

Return type

PageRoot (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaRetrievePreviewErrorPage

CustomizablePage Invoke-OktaRetrievePreviewErrorPage
[-BrandId]

Retrieve the Preview Error Page Preview

Retrieves the preview error page.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.

# Retrieve the Preview Error Page Preview
try {
    $Result = Invoke-OktaRetrievePreviewErrorPage -BrandId $BrandId
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaRetrievePreviewErrorPage: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.

Return type

CustomizablePage (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaRetrievePreviewSignInPage

SignInPage Invoke-OktaRetrievePreviewSignInPage
[-BrandId]

Retrieve the Preview Sign-in Page Preview

Retrieves the preview sign-in page.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.

# Retrieve the Preview Sign-in Page Preview
try {
    $Result = Invoke-OktaRetrievePreviewSignInPage -BrandId $BrandId
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaRetrievePreviewSignInPage: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.

Return type

SignInPage (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaRetrieveSignInPage

PageRoot Invoke-OktaRetrieveSignInPage
[-BrandId]
[-Expand] <String[]>

Retrieve the Sign-in Page

Retrieves the sign-in page.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$Expand = "default" # String[] | Specifies additional metadata to be included in the response. (optional)

# Retrieve the Sign-in Page
try {
    $Result = Invoke-OktaRetrieveSignInPage -BrandId $BrandId -Expand $Expand
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaRetrieveSignInPage: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.
Expand	String[]	Specifies additional metadata to be included in the response.	[optional]

Return type

PageRoot (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaRetrieveSignOutPageSettings

HostedPage Invoke-OktaRetrieveSignOutPageSettings
[-BrandId]

Retrieve the Sign-out Page Settings

Retrieves the sign-out page settings.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.

# Retrieve the Sign-out Page Settings
try {
    $Result = Invoke-OktaRetrieveSignOutPageSettings -BrandId $BrandId
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaRetrieveSignOutPageSettings: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.

Return type

HostedPage (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Send-OktaTestEmail

void Send-OktaTestEmail
        [-BrandId]
        [-TemplateName]
        [-Language]

Send a Test Email

Sends a test email to the current user’s primary and secondary email addresses. The email content is selected based on the following priority: 1. The email customization for the language specified in the language query parameter. 2. The email template's default customization. 3. The email template’s default content, translated to the current user's language.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$TemplateName = "MyTemplateName" # String | The name of the email template.
$Language = "MyLanguage" # String | The language to use for the email. Defaults to the current user's language if unspecified. (optional)

# Send a Test Email
try {
    $Result = Send-OktaTestEmail -BrandId $BrandId -TemplateName $TemplateName -Language $Language
} catch {
    Write-Host ("Exception occurred when calling Send-OktaTestEmail: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.
TemplateName	String	The name of the email template.
Language	String	The language to use for the email. Defaults to the current user's language if unspecified.	[optional]

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaUnlinkBrandDomain

void Invoke-OktaUnlinkBrandDomain
[-BrandId]
[-DomainId]

Unlink a Brand from a Domain

Unlink brand and domain by its unique identifier

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$DomainId = "MyDomainId" # String | The ID of the domain.

# Unlink a Brand from a Domain
try {
    $Result = Invoke-OktaUnlinkBrandDomain -BrandId $BrandId -DomainId $DomainId
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaUnlinkBrandDomain: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.
DomainId	String	The ID of the domain.

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Update-OktaBrand

Brand Update-OktaBrand
[-BrandId]
[-Brand]

Replace a Brand

Updates a brand by brandId

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$BrandRequest = Initialize-BrandRequest -AgreeToCustomPrivacyPolicy $false -CustomPrivacyPolicyUrl "MyCustomPrivacyPolicyUrl" -Name "MyName" -RemovePoweredByOkta $false # BrandRequest | 

# Replace a Brand
try {
    $Result = Update-OktaBrand -BrandId $BrandId -Brand $Brand
} catch {
    Write-Host ("Exception occurred when calling Update-OktaBrand: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.
Brand	BrandRequest

Return type

Brand (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Update-OktaBrandTheme

ThemeResponse Update-OktaBrandTheme
        [-BrandId]
        [-ThemeId]
        [-Theme]

Replace a Theme

Updates a theme for a brand

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$ThemeId = "MyThemeId" # String | The ID of the theme.
$Theme = Initialize-Theme -BackgroundImage "MyBackgroundImage" -EmailTemplateTouchPointVariant "FULL_THEME" -EndUserDashboardTouchPointVariant "FULL_THEME" -ErrorPageTouchPointVariant "BACKGROUND_IMAGE" -LoadingPageTouchPointVariant "NONE" -PrimaryColorContrastHex "MyPrimaryColorContrastHex" -PrimaryColorHex "MyPrimaryColorHex" -SecondaryColorContrastHex "MySecondaryColorContrastHex" -SecondaryColorHex "MySecondaryColorHex" -SignInPageTouchPointVariant "BACKGROUND_IMAGE" -Links @{ key_example =  } # Theme | 

# Replace a Theme
try {
    $Result = Update-OktaBrandTheme -BrandId $BrandId -ThemeId $ThemeId -Theme $Theme
} catch {
    Write-Host ("Exception occurred when calling Update-OktaBrandTheme: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description
BrandId	String	The ID of the brand.
ThemeId	String	The ID of the theme.
Theme	Theme

Return type

ThemeResponse (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Update-OktaEmailCustomization

EmailCustomization Update-OktaEmailCustomization
        [-BrandId]
        [-TemplateName]
        [-CustomizationId]
        [-Instance]

Replace an Email Customization

Updates an existing email customization using the property values provided.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$TemplateName = "MyTemplateName" # String | The name of the email template.
$CustomizationId = "MyCustomizationId" # String | The ID of the email customization.
$HrefObjectHints = Initialize-HrefObjectHints -Allow "DELETE"
$HrefObject = Initialize-HrefObject -Hints $HrefObjectHints -Href "MyHref" -Name "MyName" -Type "MyType"

$EmailCustomizationAllOfLinks = Initialize-EmailCustomizationAllOfLinks -Self $HrefObject -Template $HrefObject -Preview $HrefObject -Test $HrefObject

$EmailCustomization = Initialize-EmailCustomization -Body "MyBody" -Subject "MySubject" -Created (Get-Date) -Id "MyId" -IsDefault $false -Language "MyLanguage" -LastUpdated (Get-Date) -Links $EmailCustomizationAllOfLinks # EmailCustomization | Request (optional)

# Replace an Email Customization
try {
    $Result = Update-OktaEmailCustomization -BrandId $BrandId -TemplateName $TemplateName -CustomizationId $CustomizationId -Instance $Instance
} catch {
    Write-Host ("Exception occurred when calling Update-OktaEmailCustomization: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.
TemplateName	String	The name of the email template.
CustomizationId	String	The ID of the email customization.
Instance	EmailCustomization	Request	[optional]

Return type

EmailCustomization (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Update-OktaEmailSettings

void Update-OktaEmailSettings
        [-BrandId]
        [-TemplateName]
        [-EmailSettings]

Replace the Email Template Settings

Updates an email template's settings.

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$TemplateName = "MyTemplateName" # String | The name of the email template.
$EmailSettings = Initialize-EmailSettings -Recipients "ALL_USERS" # EmailSettings |  (optional)

# Replace the Email Template Settings
try {
    $Result = Update-OktaEmailSettings -BrandId $BrandId -TemplateName $TemplateName -EmailSettings $EmailSettings
} catch {
    Write-Host ("Exception occurred when calling Update-OktaEmailSettings: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
BrandId	String	The ID of the brand.
TemplateName	String	The name of the email template.
EmailSettings	EmailSettings		[optional]

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaUploadBrandThemeBackgroundImage

ImageUploadResponse Invoke-OktaUploadBrandThemeBackgroundImage
        [-BrandId]
        [-ThemeId]
        [-File] <System.IO.FileInfo>

Upload the Background Image

Updates the background image for your Theme

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$ThemeId = "MyThemeId" # String | The ID of the theme.
$File =  # System.IO.FileInfo | 

# Upload the Background Image
try {
    $Result = Invoke-OktaUploadBrandThemeBackgroundImage -BrandId $BrandId -ThemeId $ThemeId -File $File
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaUploadBrandThemeBackgroundImage: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description
BrandId	String	The ID of the brand.
ThemeId	String	The ID of the theme.
File	System.IO.FileInfoSystem.IO.FileInfo

Return type

ImageUploadResponse (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaUploadBrandThemeFavicon

ImageUploadResponse Invoke-OktaUploadBrandThemeFavicon
        [-BrandId]
        [-ThemeId]
        [-File] <System.IO.FileInfo>

Upload the Favicon

Updates the favicon for your theme

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$ThemeId = "MyThemeId" # String | The ID of the theme.
$File =  # System.IO.FileInfo | 

# Upload the Favicon
try {
    $Result = Invoke-OktaUploadBrandThemeFavicon -BrandId $BrandId -ThemeId $ThemeId -File $File
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaUploadBrandThemeFavicon: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description
BrandId	String	The ID of the brand.
ThemeId	String	The ID of the theme.
File	System.IO.FileInfoSystem.IO.FileInfo

Return type

ImageUploadResponse (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaUploadBrandThemeLogo

ImageUploadResponse Invoke-OktaUploadBrandThemeLogo
        [-BrandId]
        [-ThemeId]
        [-File] <System.IO.FileInfo>

Upload the Logo

Updates the logo for your Theme

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$BrandId = "MyBrandId" # String | The ID of the brand.
$ThemeId = "MyThemeId" # String | The ID of the theme.
$File =  # System.IO.FileInfo | 

# Upload the Logo
try {
    $Result = Invoke-OktaUploadBrandThemeLogo -BrandId $BrandId -ThemeId $ThemeId -File $File
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaUploadBrandThemeLogo: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description
BrandId	String	The ID of the brand.
ThemeId	String	The ID of the theme.
File	System.IO.FileInfoSystem.IO.FileInfo

Return type

ImageUploadResponse (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

OktaCustomizationApi.md

Latest commit

History

OktaCustomizationApi.md

File metadata and controls

Okta.PowerShell.Okta.PowerShell\Api.OktaCustomizationApi

New-OktaBrand

Example

Parameters

Return type

Authorization

HTTP request headers

New-OktaEmailCustomization

Example

Parameters

Return type

Authorization

HTTP request headers

Invoke-OktaDeleteAllCustomizations

Example

Parameters

Return type

Authorization

HTTP request headers

Invoke-OktaDeleteBrand

Example

Parameters

Return type

Authorization

HTTP request headers

Invoke-OktaDeleteBrandThemeBackgroundImage

Example

Parameters

Return type

Authorization

HTTP request headers

Invoke-OktaDeleteBrandThemeFavicon

Example

Parameters

Return type

Authorization

HTTP request headers

Invoke-OktaDeleteBrandThemeLogo

Example

Parameters

Return type

Authorization

HTTP request headers

Invoke-OktaDeleteEmailCustomization

Example

Parameters

Return type

Authorization

HTTP request headers

Get-OktaBrand

Example

Parameters

Return type

Authorization

HTTP request headers

Get-OktaBrandDomains

Example

Parameters

Return type

Authorization

HTTP request headers

Get-OktaBrandTheme

Example

Parameters

Return type

Authorization

HTTP request headers

Get-OktaCustomizationPreview

Example

Parameters

Return type

Authorization

HTTP request headers

Get-OktaEmailCustomization