CustomizationAPI.md

\CustomizationAPI

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

Method	HTTP request	Description
CreateBrand	Post /api/v1/brands	Create a Brand
CreateEmailCustomization	Post /api/v1/brands/{brandId}/templates/email/{templateName}/customizations	Create an Email Customization
DeleteAllCustomizations	Delete /api/v1/brands/{brandId}/templates/email/{templateName}/customizations	Delete all Email Customizations
DeleteBrand	Delete /api/v1/brands/{brandId}	Delete a brand
DeleteBrandThemeBackgroundImage	Delete /api/v1/brands/{brandId}/themes/{themeId}/background-image	Delete the Background Image
DeleteBrandThemeFavicon	Delete /api/v1/brands/{brandId}/themes/{themeId}/favicon	Delete the Favicon
DeleteBrandThemeLogo	Delete /api/v1/brands/{brandId}/themes/{themeId}/logo	Delete the Logo
DeleteCustomizedErrorPage	Delete /api/v1/brands/{brandId}/pages/error/customized	Delete the Customized Error Page
DeleteCustomizedSignInPage	Delete /api/v1/brands/{brandId}/pages/sign-in/customized	Delete the Customized Sign-in Page
DeleteEmailCustomization	Delete /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}	Delete an Email Customization
DeletePreviewErrorPage	Delete /api/v1/brands/{brandId}/pages/error/preview	Delete the Preview Error Page
DeletePreviewSignInPage	Delete /api/v1/brands/{brandId}/pages/sign-in/preview	Delete the Preview Sign-in Page
GetBrand	Get /api/v1/brands/{brandId}	Retrieve a Brand
GetBrandTheme	Get /api/v1/brands/{brandId}/themes/{themeId}	Retrieve a Theme
GetCustomizationPreview	Get /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}/preview	Retrieve a Preview of an Email Customization
GetCustomizedErrorPage	Get /api/v1/brands/{brandId}/pages/error/customized	Retrieve the Customized Error Page
GetCustomizedSignInPage	Get /api/v1/brands/{brandId}/pages/sign-in/customized	Retrieve the Customized Sign-in Page
GetDefaultErrorPage	Get /api/v1/brands/{brandId}/pages/error/default	Retrieve the Default Error Page
GetDefaultSignInPage	Get /api/v1/brands/{brandId}/pages/sign-in/default	Retrieve the Default Sign-in Page
GetEmailCustomization	Get /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}	Retrieve an Email Customization
GetEmailDefaultContent	Get /api/v1/brands/{brandId}/templates/email/{templateName}/default-content	Retrieve an Email Template Default Content
GetEmailDefaultPreview	Get /api/v1/brands/{brandId}/templates/email/{templateName}/default-content/preview	Retrieve a Preview of the Email Template default content
GetEmailSettings	Get /api/v1/brands/{brandId}/templates/email/{templateName}/settings	Retrieve the Email Template Settings
GetEmailTemplate	Get /api/v1/brands/{brandId}/templates/email/{templateName}	Retrieve an Email Template
GetErrorPage	Get /api/v1/brands/{brandId}/pages/error	Retrieve the Error Page Sub-Resources
GetPreviewErrorPage	Get /api/v1/brands/{brandId}/pages/error/preview	Retrieve the Preview Error Page Preview
GetPreviewSignInPage	Get /api/v1/brands/{brandId}/pages/sign-in/preview	Retrieve the Preview Sign-in Page Preview
GetSignInPage	Get /api/v1/brands/{brandId}/pages/sign-in	Retrieve the Sign-in Page Sub-Resources
GetSignOutPageSettings	Get /api/v1/brands/{brandId}/pages/sign-out/customized	Retrieve the Sign-out Page Settings
ListAllSignInWidgetVersions	Get /api/v1/brands/{brandId}/pages/sign-in/widget-versions	List all Sign-in Widget Versions
ListBrandDomains	Get /api/v1/brands/{brandId}/domains	List all Domains associated with a Brand
ListBrandThemes	Get /api/v1/brands/{brandId}/themes	List all Themes
ListBrands	Get /api/v1/brands	List all Brands
ListEmailCustomizations	Get /api/v1/brands/{brandId}/templates/email/{templateName}/customizations	List all Email Customizations
ListEmailTemplates	Get /api/v1/brands/{brandId}/templates/email	List all Email Templates
ReplaceBrand	Put /api/v1/brands/{brandId}	Replace a Brand
ReplaceBrandTheme	Put /api/v1/brands/{brandId}/themes/{themeId}	Replace a Theme
ReplaceCustomizedErrorPage	Put /api/v1/brands/{brandId}/pages/error/customized	Replace the Customized Error Page
ReplaceCustomizedSignInPage	Put /api/v1/brands/{brandId}/pages/sign-in/customized	Replace the Customized Sign-in Page
ReplaceEmailCustomization	Put /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}	Replace an Email Customization
ReplaceEmailSettings	Put /api/v1/brands/{brandId}/templates/email/{templateName}/settings	Replace the Email Template Settings
ReplacePreviewErrorPage	Put /api/v1/brands/{brandId}/pages/error/preview	Replace the Preview Error Page
ReplacePreviewSignInPage	Put /api/v1/brands/{brandId}/pages/sign-in/preview	Replace the Preview Sign-in Page
ReplaceSignOutPageSettings	Put /api/v1/brands/{brandId}/pages/sign-out/customized	Replace the Sign-out Page Settings
SendTestEmail	Post /api/v1/brands/{brandId}/templates/email/{templateName}/test	Send a Test Email
UploadBrandThemeBackgroundImage	Post /api/v1/brands/{brandId}/themes/{themeId}/background-image	Upload the Background Image
UploadBrandThemeFavicon	Post /api/v1/brands/{brandId}/themes/{themeId}/favicon	Upload the Favicon
UploadBrandThemeLogo	Post /api/v1/brands/{brandId}/themes/{themeId}/logo	Upload the Logo

CreateBrand

Brand CreateBrand(ctx).Expand(expand).After(after).Limit(limit).Q(q).CreateBrandRequest(createBrandRequest).Execute()

Create a Brand

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    expand := []string{"Expand_example"} // []string | Specifies additional metadata to be included in the response (optional)
    after := "after_example" // 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). (optional)
    limit := int32(56) // int32 | A limit on the number of objects to return (optional) (default to 20)
    q := "q_example" // string | Searches the records for matching value (optional)
    createBrandRequest := *openapiclient.NewCreateBrandRequest("Name_example") // CreateBrandRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.CreateBrand(context.Background()).Expand(expand).After(after).Limit(limit).Q(q).CreateBrandRequest(createBrandRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.CreateBrand``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateBrand`: Brand
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.CreateBrand`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreateBrandRequest struct via the builder pattern

Name	Type	Description	Notes
expand	[]string	Specifies additional metadata to be included in the response
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.
limit	int32	A limit on the number of objects to return	[default to 20]
q	string	Searches the records for matching value
createBrandRequest	CreateBrandRequest

Return type

Brand

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]

CreateEmailCustomization

EmailCustomization CreateEmailCustomization(ctx, brandId, templateName).Instance(instance).Execute()

Create an Email Customization

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    templateName := "templateName_example" // string | The name of the email template
    instance := *openapiclient.NewEmailCustomization("Body_example", "Subject_example", "Language_example") // EmailCustomization |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.CreateEmailCustomization(context.Background(), brandId, templateName).Instance(instance).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.CreateEmailCustomization``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateEmailCustomization`: EmailCustomization
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.CreateEmailCustomization`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand
templateName	string	The name of the email template

Other Parameters

Other parameters are passed through a pointer to a apiCreateEmailCustomizationRequest struct via the builder pattern

Name	Type	Description	Notes

instance | EmailCustomization | |

Return type

EmailCustomization

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]

DeleteAllCustomizations

DeleteAllCustomizations(ctx, brandId, templateName).Execute()

Delete all Email Customizations

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    templateName := "templateName_example" // string | The name of the email template

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.CustomizationAPI.DeleteAllCustomizations(context.Background(), brandId, templateName).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.DeleteAllCustomizations``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand
templateName	string	The name of the email template

Other Parameters

Other parameters are passed through a pointer to a apiDeleteAllCustomizationsRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(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]

DeleteBrand

DeleteBrand(ctx, brandId).Expand(expand).Execute()

Delete a brand

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    expand := []string{"Expand_example"} // []string | Specifies additional metadata to be included in the response (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.CustomizationAPI.DeleteBrand(context.Background(), brandId).Expand(expand).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.DeleteBrand``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand

Other Parameters

Other parameters are passed through a pointer to a apiDeleteBrandRequest struct via the builder pattern

Name	Type	Description	Notes

expand | []string | Specifies additional metadata to be included in the response |

Return type

(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]

DeleteBrandThemeBackgroundImage

DeleteBrandThemeBackgroundImage(ctx, brandId, themeId).Execute()

Delete the Background Image

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    themeId := "themeId_example" // string | The ID of the theme

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.CustomizationAPI.DeleteBrandThemeBackgroundImage(context.Background(), brandId, themeId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.DeleteBrandThemeBackgroundImage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand
themeId	string	The ID of the theme

Other Parameters

Other parameters are passed through a pointer to a apiDeleteBrandThemeBackgroundImageRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(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]

DeleteBrandThemeFavicon

DeleteBrandThemeFavicon(ctx, brandId, themeId).Execute()

Delete the Favicon

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    themeId := "themeId_example" // string | The ID of the theme

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.CustomizationAPI.DeleteBrandThemeFavicon(context.Background(), brandId, themeId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.DeleteBrandThemeFavicon``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand
themeId	string	The ID of the theme

Other Parameters

Other parameters are passed through a pointer to a apiDeleteBrandThemeFaviconRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(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]

DeleteBrandThemeLogo

DeleteBrandThemeLogo(ctx, brandId, themeId).Execute()

Delete the Logo

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    themeId := "themeId_example" // string | The ID of the theme

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.CustomizationAPI.DeleteBrandThemeLogo(context.Background(), brandId, themeId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.DeleteBrandThemeLogo``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand
themeId	string	The ID of the theme

Other Parameters

Other parameters are passed through a pointer to a apiDeleteBrandThemeLogoRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(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]

DeleteCustomizedErrorPage

DeleteCustomizedErrorPage(ctx, brandId).Execute()

Delete the Customized Error Page

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.CustomizationAPI.DeleteCustomizedErrorPage(context.Background(), brandId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.DeleteCustomizedErrorPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand

Other Parameters

Other parameters are passed through a pointer to a apiDeleteCustomizedErrorPageRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(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]

DeleteCustomizedSignInPage

DeleteCustomizedSignInPage(ctx, brandId).Execute()

Delete the Customized Sign-in Page

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.CustomizationAPI.DeleteCustomizedSignInPage(context.Background(), brandId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.DeleteCustomizedSignInPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand

Other Parameters

Other parameters are passed through a pointer to a apiDeleteCustomizedSignInPageRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(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]

DeleteEmailCustomization

DeleteEmailCustomization(ctx, brandId, templateName, customizationId).Execute()

Delete an Email Customization

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    templateName := "templateName_example" // string | The name of the email template
    customizationId := "customizationId_example" // string | The ID of the email customization

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.CustomizationAPI.DeleteEmailCustomization(context.Background(), brandId, templateName, customizationId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.DeleteEmailCustomization``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand
templateName	string	The name of the email template
customizationId	string	The ID of the email customization

Other Parameters

Other parameters are passed through a pointer to a apiDeleteEmailCustomizationRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(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]

DeletePreviewErrorPage

DeletePreviewErrorPage(ctx, brandId).Execute()

Delete the Preview Error Page

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.CustomizationAPI.DeletePreviewErrorPage(context.Background(), brandId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.DeletePreviewErrorPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand

Other Parameters

Other parameters are passed through a pointer to a apiDeletePreviewErrorPageRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(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]

DeletePreviewSignInPage

DeletePreviewSignInPage(ctx, brandId).Execute()

Delete the Preview Sign-in Page

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.CustomizationAPI.DeletePreviewSignInPage(context.Background(), brandId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.DeletePreviewSignInPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand

Other Parameters

Other parameters are passed through a pointer to a apiDeletePreviewSignInPageRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(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]

GetBrand

BrandWithEmbedded GetBrand(ctx, brandId).Expand(expand).Execute()

Retrieve a Brand

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    expand := []string{"Expand_example"} // []string | Specifies additional metadata to be included in the response (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.GetBrand(context.Background(), brandId).Expand(expand).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.GetBrand``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetBrand`: BrandWithEmbedded
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.GetBrand`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand

Other Parameters

Other parameters are passed through a pointer to a apiGetBrandRequest struct via the builder pattern

Name	Type	Description	Notes

expand | []string | Specifies additional metadata to be included in the response |

Return type

BrandWithEmbedded

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]

GetBrandTheme

ThemeResponse GetBrandTheme(ctx, brandId, themeId).Execute()

Retrieve a Theme

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    themeId := "themeId_example" // string | The ID of the theme

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.GetBrandTheme(context.Background(), brandId, themeId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.GetBrandTheme``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetBrandTheme`: ThemeResponse
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.GetBrandTheme`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand
themeId	string	The ID of the theme

Other Parameters

Other parameters are passed through a pointer to a apiGetBrandThemeRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ThemeResponse

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]

GetCustomizationPreview

EmailPreview GetCustomizationPreview(ctx, brandId, templateName, customizationId).Execute()

Retrieve a Preview of an Email Customization

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    templateName := "templateName_example" // string | The name of the email template
    customizationId := "customizationId_example" // string | The ID of the email customization

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.GetCustomizationPreview(context.Background(), brandId, templateName, customizationId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.GetCustomizationPreview``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetCustomizationPreview`: EmailPreview
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.GetCustomizationPreview`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand
templateName	string	The name of the email template
customizationId	string	The ID of the email customization

Other Parameters

Other parameters are passed through a pointer to a apiGetCustomizationPreviewRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

EmailPreview

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]

GetCustomizedErrorPage

ErrorPage GetCustomizedErrorPage(ctx, brandId).Execute()

Retrieve the Customized Error Page

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.GetCustomizedErrorPage(context.Background(), brandId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.GetCustomizedErrorPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetCustomizedErrorPage`: ErrorPage
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.GetCustomizedErrorPage`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand

Other Parameters

Other parameters are passed through a pointer to a apiGetCustomizedErrorPageRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ErrorPage

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]

GetCustomizedSignInPage

SignInPage GetCustomizedSignInPage(ctx, brandId).Execute()

Retrieve the Customized Sign-in Page

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.GetCustomizedSignInPage(context.Background(), brandId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.GetCustomizedSignInPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetCustomizedSignInPage`: SignInPage
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.GetCustomizedSignInPage`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand

Other Parameters

Other parameters are passed through a pointer to a apiGetCustomizedSignInPageRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

SignInPage

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]

GetDefaultErrorPage

ErrorPage GetDefaultErrorPage(ctx, brandId).Execute()

Retrieve the Default Error Page

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.GetDefaultErrorPage(context.Background(), brandId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.GetDefaultErrorPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetDefaultErrorPage`: ErrorPage
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.GetDefaultErrorPage`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand

Other Parameters

Other parameters are passed through a pointer to a apiGetDefaultErrorPageRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ErrorPage

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]

GetDefaultSignInPage

SignInPage GetDefaultSignInPage(ctx, brandId).Execute()

Retrieve the Default Sign-in Page

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.GetDefaultSignInPage(context.Background(), brandId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.GetDefaultSignInPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetDefaultSignInPage`: SignInPage
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.GetDefaultSignInPage`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand

Other Parameters

Other parameters are passed through a pointer to a apiGetDefaultSignInPageRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

SignInPage

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]

GetEmailCustomization

EmailCustomization GetEmailCustomization(ctx, brandId, templateName, customizationId).Execute()

Retrieve an Email Customization

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    templateName := "templateName_example" // string | The name of the email template
    customizationId := "customizationId_example" // string | The ID of the email customization

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.GetEmailCustomization(context.Background(), brandId, templateName, customizationId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.GetEmailCustomization``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetEmailCustomization`: EmailCustomization
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.GetEmailCustomization`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand
templateName	string	The name of the email template
customizationId	string	The ID of the email customization

Other Parameters

Other parameters are passed through a pointer to a apiGetEmailCustomizationRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

EmailCustomization

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]

GetEmailDefaultContent

EmailDefaultContent GetEmailDefaultContent(ctx, brandId, templateName).Language(language).Execute()

Retrieve an Email Template Default Content

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    templateName := "templateName_example" // string | The name of the email template
    language := "language_example" // string | The language to use for the email. Defaults to the current user's language if unspecified. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.GetEmailDefaultContent(context.Background(), brandId, templateName).Language(language).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.GetEmailDefaultContent``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetEmailDefaultContent`: EmailDefaultContent
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.GetEmailDefaultContent`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand
templateName	string	The name of the email template

Other Parameters

Other parameters are passed through a pointer to a apiGetEmailDefaultContentRequest struct via the builder pattern

Name	Type	Description	Notes

language | string | The language to use for the email. Defaults to the current user's language if unspecified. |

Return type

EmailDefaultContent

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]

GetEmailDefaultPreview

EmailPreview GetEmailDefaultPreview(ctx, brandId, templateName).Language(language).Execute()

Retrieve a Preview of the Email Template default content

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    templateName := "templateName_example" // string | The name of the email template
    language := "language_example" // string | The language to use for the email. Defaults to the current user's language if unspecified. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.GetEmailDefaultPreview(context.Background(), brandId, templateName).Language(language).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.GetEmailDefaultPreview``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetEmailDefaultPreview`: EmailPreview
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.GetEmailDefaultPreview`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand
templateName	string	The name of the email template

Other Parameters

Other parameters are passed through a pointer to a apiGetEmailDefaultPreviewRequest struct via the builder pattern

Name	Type	Description	Notes

language | string | The language to use for the email. Defaults to the current user's language if unspecified. |

Return type

EmailPreview

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]

GetEmailSettings

EmailSettings GetEmailSettings(ctx, brandId, templateName).Execute()

Retrieve the Email Template Settings

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    templateName := "templateName_example" // string | The name of the email template

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.GetEmailSettings(context.Background(), brandId, templateName).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.GetEmailSettings``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetEmailSettings`: EmailSettings
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.GetEmailSettings`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand
templateName	string	The name of the email template

Other Parameters

Other parameters are passed through a pointer to a apiGetEmailSettingsRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

EmailSettings

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]

GetEmailTemplate

EmailTemplate GetEmailTemplate(ctx, brandId, templateName).Expand(expand).Execute()

Retrieve an Email Template

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    templateName := "templateName_example" // string | The name of the email template
    expand := []string{"Expand_example"} // []string | Specifies additional metadata to be included in the response (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.GetEmailTemplate(context.Background(), brandId, templateName).Expand(expand).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.GetEmailTemplate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetEmailTemplate`: EmailTemplate
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.GetEmailTemplate`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand
templateName	string	The name of the email template

Other Parameters

Other parameters are passed through a pointer to a apiGetEmailTemplateRequest struct via the builder pattern

Name	Type	Description	Notes

expand | []string | Specifies additional metadata to be included in the response |

Return type

EmailTemplate

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]

GetErrorPage

PageRoot GetErrorPage(ctx, brandId).Expand(expand).Execute()

Retrieve the Error Page Sub-Resources

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    expand := []string{"Expand_example"} // []string | Specifies additional metadata to be included in the response (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.GetErrorPage(context.Background(), brandId).Expand(expand).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.GetErrorPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetErrorPage`: PageRoot
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.GetErrorPage`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand

Other Parameters

Other parameters are passed through a pointer to a apiGetErrorPageRequest struct via the builder pattern

Name	Type	Description	Notes

expand | []string | Specifies additional metadata to be included in the response |

Return type

PageRoot

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]

GetPreviewErrorPage

ErrorPage GetPreviewErrorPage(ctx, brandId).Execute()

Retrieve the Preview Error Page Preview

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.GetPreviewErrorPage(context.Background(), brandId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.GetPreviewErrorPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetPreviewErrorPage`: ErrorPage
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.GetPreviewErrorPage`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand

Other Parameters

Other parameters are passed through a pointer to a apiGetPreviewErrorPageRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ErrorPage

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]

GetPreviewSignInPage

SignInPage GetPreviewSignInPage(ctx, brandId).Execute()

Retrieve the Preview Sign-in Page Preview

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.GetPreviewSignInPage(context.Background(), brandId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.GetPreviewSignInPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetPreviewSignInPage`: SignInPage
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.GetPreviewSignInPage`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand

Other Parameters

Other parameters are passed through a pointer to a apiGetPreviewSignInPageRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

SignInPage

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]

GetSignInPage

PageRoot GetSignInPage(ctx, brandId).Expand(expand).Execute()

Retrieve the Sign-in Page Sub-Resources

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    expand := []string{"Expand_example"} // []string | Specifies additional metadata to be included in the response (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.GetSignInPage(context.Background(), brandId).Expand(expand).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.GetSignInPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetSignInPage`: PageRoot
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.GetSignInPage`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand

Other Parameters

Other parameters are passed through a pointer to a apiGetSignInPageRequest struct via the builder pattern

Name	Type	Description	Notes

expand | []string | Specifies additional metadata to be included in the response |

Return type

PageRoot

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]

GetSignOutPageSettings

HostedPage GetSignOutPageSettings(ctx, brandId).Execute()

Retrieve the Sign-out Page Settings

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.GetSignOutPageSettings(context.Background(), brandId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.GetSignOutPageSettings``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetSignOutPageSettings`: HostedPage
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.GetSignOutPageSettings`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand

Other Parameters

Other parameters are passed through a pointer to a apiGetSignOutPageSettingsRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

HostedPage

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]

ListAllSignInWidgetVersions

[]string ListAllSignInWidgetVersions(ctx, brandId).Execute()

List all Sign-in Widget Versions

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.ListAllSignInWidgetVersions(context.Background(), brandId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.ListAllSignInWidgetVersions``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListAllSignInWidgetVersions`: []string
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.ListAllSignInWidgetVersions`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand

Other Parameters

Other parameters are passed through a pointer to a apiListAllSignInWidgetVersionsRequest struct via the builder pattern

Name	Type	Description	Notes

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]

ListBrandDomains

[]DomainResponse ListBrandDomains(ctx, brandId).Execute()

List all Domains associated with a Brand

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.ListBrandDomains(context.Background(), brandId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.ListBrandDomains``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListBrandDomains`: []DomainResponse
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.ListBrandDomains`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand

Other Parameters

Other parameters are passed through a pointer to a apiListBrandDomainsRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]DomainResponse

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]

ListBrandThemes

[]ThemeResponse ListBrandThemes(ctx, brandId).Execute()

List all Themes

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.ListBrandThemes(context.Background(), brandId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.ListBrandThemes``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListBrandThemes`: []ThemeResponse
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.ListBrandThemes`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand

Other Parameters

Other parameters are passed through a pointer to a apiListBrandThemesRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]ThemeResponse

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]

ListBrands

[]BrandWithEmbedded ListBrands(ctx).Expand(expand).After(after).Limit(limit).Q(q).Execute()

List all Brands

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    expand := []string{"Expand_example"} // []string | Specifies additional metadata to be included in the response (optional)
    after := "after_example" // 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). (optional)
    limit := int32(56) // int32 | A limit on the number of objects to return (optional) (default to 20)
    q := "q_example" // string | Searches the records for matching value (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.ListBrands(context.Background()).Expand(expand).After(after).Limit(limit).Q(q).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.ListBrands``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListBrands`: []BrandWithEmbedded
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.ListBrands`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiListBrandsRequest struct via the builder pattern

Name	Type	Description	Notes
expand	[]string	Specifies additional metadata to be included in the response
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.
limit	int32	A limit on the number of objects to return	[default to 20]
q	string	Searches the records for matching value

Return type

[]BrandWithEmbedded

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]

ListEmailCustomizations

[]EmailCustomization ListEmailCustomizations(ctx, brandId, templateName).After(after).Limit(limit).Execute()

List all Email Customizations

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    templateName := "templateName_example" // string | The name of the email template
    after := "after_example" // 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). (optional)
    limit := int32(56) // int32 | A limit on the number of objects to return (optional) (default to 20)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.ListEmailCustomizations(context.Background(), brandId, templateName).After(after).Limit(limit).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.ListEmailCustomizations``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListEmailCustomizations`: []EmailCustomization
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.ListEmailCustomizations`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand
templateName	string	The name of the email template

Other Parameters

Other parameters are passed through a pointer to a apiListEmailCustomizationsRequest struct via the builder pattern

Name	Type	Description	Notes

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. | limit | int32 | A limit on the number of objects to return | [default to 20]

Return type

[]EmailCustomization

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]

ListEmailTemplates

[]EmailTemplate ListEmailTemplates(ctx, brandId).After(after).Limit(limit).Expand(expand).Execute()

List all Email Templates

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    after := "after_example" // 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). (optional)
    limit := int32(56) // int32 | A limit on the number of objects to return (optional) (default to 20)
    expand := []string{"Expand_example"} // []string | Specifies additional metadata to be included in the response (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.ListEmailTemplates(context.Background(), brandId).After(after).Limit(limit).Expand(expand).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.ListEmailTemplates``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListEmailTemplates`: []EmailTemplate
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.ListEmailTemplates`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand

Other Parameters

Other parameters are passed through a pointer to a apiListEmailTemplatesRequest struct via the builder pattern

Name	Type	Description	Notes

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. | limit | int32 | A limit on the number of objects to return | [default to 20] expand | []string | Specifies additional metadata to be included in the response |

Return type

[]EmailTemplate

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]

ReplaceBrand

Brand ReplaceBrand(ctx, brandId).Brand(brand).Expand(expand).Execute()

Replace a Brand

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    brand := *openapiclient.NewBrandRequest() // BrandRequest | 
    expand := []string{"Expand_example"} // []string | Specifies additional metadata to be included in the response (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.ReplaceBrand(context.Background(), brandId).Brand(brand).Expand(expand).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.ReplaceBrand``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ReplaceBrand`: Brand
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.ReplaceBrand`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand

Other Parameters

Other parameters are passed through a pointer to a apiReplaceBrandRequest struct via the builder pattern

Name	Type	Description	Notes

brand | BrandRequest | | expand | []string | Specifies additional metadata to be included in the response |

Return type

Brand

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]

ReplaceBrandTheme

ThemeResponse ReplaceBrandTheme(ctx, brandId, themeId).Theme(theme).Execute()

Replace a Theme

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    themeId := "themeId_example" // string | The ID of the theme
    theme := *openapiclient.NewTheme() // Theme | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.ReplaceBrandTheme(context.Background(), brandId, themeId).Theme(theme).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.ReplaceBrandTheme``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ReplaceBrandTheme`: ThemeResponse
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.ReplaceBrandTheme`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand
themeId	string	The ID of the theme

Other Parameters

Other parameters are passed through a pointer to a apiReplaceBrandThemeRequest struct via the builder pattern

Name	Type	Description	Notes

theme | Theme | |

Return type

ThemeResponse

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]

ReplaceCustomizedErrorPage

ErrorPage ReplaceCustomizedErrorPage(ctx, brandId).ErrorPage(errorPage).Execute()

Replace the Customized Error Page

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    errorPage := *openapiclient.NewErrorPage() // ErrorPage | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.ReplaceCustomizedErrorPage(context.Background(), brandId).ErrorPage(errorPage).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.ReplaceCustomizedErrorPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ReplaceCustomizedErrorPage`: ErrorPage
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.ReplaceCustomizedErrorPage`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand

Other Parameters

Other parameters are passed through a pointer to a apiReplaceCustomizedErrorPageRequest struct via the builder pattern

Name	Type	Description	Notes

errorPage | ErrorPage | |

Return type

ErrorPage

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]

ReplaceCustomizedSignInPage

SignInPage ReplaceCustomizedSignInPage(ctx, brandId).SignInPage(signInPage).Execute()

Replace the Customized Sign-in Page

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    signInPage := *openapiclient.NewSignInPage() // SignInPage | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.ReplaceCustomizedSignInPage(context.Background(), brandId).SignInPage(signInPage).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.ReplaceCustomizedSignInPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ReplaceCustomizedSignInPage`: SignInPage
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.ReplaceCustomizedSignInPage`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand

Other Parameters

Other parameters are passed through a pointer to a apiReplaceCustomizedSignInPageRequest struct via the builder pattern

Name	Type	Description	Notes

signInPage | SignInPage | |

Return type

SignInPage

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]

ReplaceEmailCustomization

EmailCustomization ReplaceEmailCustomization(ctx, brandId, templateName, customizationId).Instance(instance).Execute()

Replace an Email Customization

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    templateName := "templateName_example" // string | The name of the email template
    customizationId := "customizationId_example" // string | The ID of the email customization
    instance := *openapiclient.NewEmailCustomization("Body_example", "Subject_example", "Language_example") // EmailCustomization | Request (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.ReplaceEmailCustomization(context.Background(), brandId, templateName, customizationId).Instance(instance).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.ReplaceEmailCustomization``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ReplaceEmailCustomization`: EmailCustomization
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.ReplaceEmailCustomization`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand
templateName	string	The name of the email template
customizationId	string	The ID of the email customization

Other Parameters

Other parameters are passed through a pointer to a apiReplaceEmailCustomizationRequest struct via the builder pattern

Name	Type	Description	Notes

instance | EmailCustomization | Request |

Return type

EmailCustomization

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]

ReplaceEmailSettings

ReplaceEmailSettings(ctx, brandId, templateName).EmailSettings(emailSettings).Execute()

Replace the Email Template Settings

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    templateName := "templateName_example" // string | The name of the email template
    emailSettings := *openapiclient.NewEmailSettings("Recipients_example") // EmailSettings |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.CustomizationAPI.ReplaceEmailSettings(context.Background(), brandId, templateName).EmailSettings(emailSettings).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.ReplaceEmailSettings``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand
templateName	string	The name of the email template

Other Parameters

Other parameters are passed through a pointer to a apiReplaceEmailSettingsRequest struct via the builder pattern

Name	Type	Description	Notes

emailSettings | EmailSettings | |

Return type

(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]

ReplacePreviewErrorPage

ErrorPage ReplacePreviewErrorPage(ctx, brandId).ErrorPage(errorPage).Execute()

Replace the Preview Error Page

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    errorPage := *openapiclient.NewErrorPage() // ErrorPage | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.ReplacePreviewErrorPage(context.Background(), brandId).ErrorPage(errorPage).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.ReplacePreviewErrorPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ReplacePreviewErrorPage`: ErrorPage
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.ReplacePreviewErrorPage`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand

Other Parameters

Other parameters are passed through a pointer to a apiReplacePreviewErrorPageRequest struct via the builder pattern

Name	Type	Description	Notes

errorPage | ErrorPage | |

Return type

ErrorPage

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]

ReplacePreviewSignInPage

SignInPage ReplacePreviewSignInPage(ctx, brandId).SignInPage(signInPage).Execute()

Replace the Preview Sign-in Page

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    signInPage := *openapiclient.NewSignInPage() // SignInPage | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.ReplacePreviewSignInPage(context.Background(), brandId).SignInPage(signInPage).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.ReplacePreviewSignInPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ReplacePreviewSignInPage`: SignInPage
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.ReplacePreviewSignInPage`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand

Other Parameters

Other parameters are passed through a pointer to a apiReplacePreviewSignInPageRequest struct via the builder pattern

Name	Type	Description	Notes

signInPage | SignInPage | |

Return type

SignInPage

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]

ReplaceSignOutPageSettings

HostedPage ReplaceSignOutPageSettings(ctx, brandId).HostedPage(hostedPage).Execute()

Replace the Sign-out Page Settings

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    hostedPage := *openapiclient.NewHostedPage("Type_example") // HostedPage | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.ReplaceSignOutPageSettings(context.Background(), brandId).HostedPage(hostedPage).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.ReplaceSignOutPageSettings``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ReplaceSignOutPageSettings`: HostedPage
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.ReplaceSignOutPageSettings`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand

Other Parameters

Other parameters are passed through a pointer to a apiReplaceSignOutPageSettingsRequest struct via the builder pattern

Name	Type	Description	Notes

hostedPage | HostedPage | |

Return type

HostedPage

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]

SendTestEmail

SendTestEmail(ctx, brandId, templateName).Language(language).Execute()

Send a Test Email

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    templateName := "templateName_example" // string | The name of the email template
    language := "language_example" // string | The language to use for the email. Defaults to the current user's language if unspecified. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.CustomizationAPI.SendTestEmail(context.Background(), brandId, templateName).Language(language).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.SendTestEmail``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand
templateName	string	The name of the email template

Other Parameters

Other parameters are passed through a pointer to a apiSendTestEmailRequest struct via the builder pattern

Name	Type	Description	Notes

language | string | The language to use for the email. Defaults to the current user's language if unspecified. |

Return type

(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]

UploadBrandThemeBackgroundImage

ImageUploadResponse UploadBrandThemeBackgroundImage(ctx, brandId, themeId).File(file).Execute()

Upload the Background Image

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    themeId := "themeId_example" // string | The ID of the theme
    file := os.NewFile(1234, "some_file") // *os.File | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.UploadBrandThemeBackgroundImage(context.Background(), brandId, themeId).File(file).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.UploadBrandThemeBackgroundImage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UploadBrandThemeBackgroundImage`: ImageUploadResponse
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.UploadBrandThemeBackgroundImage`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand
themeId	string	The ID of the theme

Other Parameters

Other parameters are passed through a pointer to a apiUploadBrandThemeBackgroundImageRequest struct via the builder pattern

Name	Type	Description	Notes

file | *os.File | |

Return type

ImageUploadResponse

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]

UploadBrandThemeFavicon

ImageUploadResponse UploadBrandThemeFavicon(ctx, brandId, themeId).File(file).Execute()

Upload the Favicon

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    themeId := "themeId_example" // string | The ID of the theme
    file := os.NewFile(1234, "some_file") // *os.File | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.UploadBrandThemeFavicon(context.Background(), brandId, themeId).File(file).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.UploadBrandThemeFavicon``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UploadBrandThemeFavicon`: ImageUploadResponse
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.UploadBrandThemeFavicon`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand
themeId	string	The ID of the theme

Other Parameters

Other parameters are passed through a pointer to a apiUploadBrandThemeFaviconRequest struct via the builder pattern

Name	Type	Description	Notes

file | *os.File | |

Return type

ImageUploadResponse

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]

UploadBrandThemeLogo

ImageUploadResponse UploadBrandThemeLogo(ctx, brandId, themeId).File(file).Execute()

Upload the Logo

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    brandId := "brandId_example" // string | The ID of the brand
    themeId := "themeId_example" // string | The ID of the theme
    file := os.NewFile(1234, "some_file") // *os.File | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CustomizationAPI.UploadBrandThemeLogo(context.Background(), brandId, themeId).File(file).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomizationAPI.UploadBrandThemeLogo``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UploadBrandThemeLogo`: ImageUploadResponse
    fmt.Fprintf(os.Stdout, "Response from `CustomizationAPI.UploadBrandThemeLogo`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
brandId	string	The ID of the brand
themeId	string	The ID of the theme

Other Parameters

Other parameters are passed through a pointer to a apiUploadBrandThemeLogoRequest struct via the builder pattern

Name	Type	Description	Notes

file | *os.File | |

Return type

ImageUploadResponse

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]