okta.OrgConfiguration
Manages org settings, logo, support and communication.
IMPORTANT: You must specify all Org Setting properties when you update an org’s profile. Any property not specified in the script will be deleted.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";
const example = new okta.OrgConfiguration("example", {
    companyName: "Umbrella Corporation",
    website: "https://terraform.io",
});
import pulumi
import pulumi_okta as okta
example = okta.OrgConfiguration("example",
    company_name="Umbrella Corporation",
    website="https://terraform.io")
package main
import (
	"github.com/pulumi/pulumi-okta/sdk/v6/go/okta"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := okta.NewOrgConfiguration(ctx, "example", &okta.OrgConfigurationArgs{
			CompanyName: pulumi.String("Umbrella Corporation"),
			Website:     pulumi.String("https://terraform.io"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Okta = Pulumi.Okta;
return await Deployment.RunAsync(() => 
{
    var example = new Okta.OrgConfiguration("example", new()
    {
        CompanyName = "Umbrella Corporation",
        Website = "https://terraform.io",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.OrgConfiguration;
import com.pulumi.okta.OrgConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new OrgConfiguration("example", OrgConfigurationArgs.builder()
            .companyName("Umbrella Corporation")
            .website("https://terraform.io")
            .build());
    }
}
resources:
  example:
    type: okta:OrgConfiguration
    properties:
      companyName: Umbrella Corporation
      website: https://terraform.io
Create OrgConfiguration Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new OrgConfiguration(name: string, args: OrgConfigurationArgs, opts?: CustomResourceOptions);@overload
def OrgConfiguration(resource_name: str,
                     args: OrgConfigurationArgs,
                     opts: Optional[ResourceOptions] = None)
@overload
def OrgConfiguration(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     company_name: Optional[str] = None,
                     end_user_support_help_url: Optional[str] = None,
                     opt_out_communication_emails: Optional[bool] = None,
                     city: Optional[str] = None,
                     address2: Optional[str] = None,
                     country: Optional[str] = None,
                     address1: Optional[str] = None,
                     logo: Optional[str] = None,
                     billing_contact_user: Optional[str] = None,
                     phone_number: Optional[str] = None,
                     postal_code: Optional[str] = None,
                     state: Optional[str] = None,
                     support_phone_number: Optional[str] = None,
                     technical_contact_user: Optional[str] = None,
                     website: Optional[str] = None)func NewOrgConfiguration(ctx *Context, name string, args OrgConfigurationArgs, opts ...ResourceOption) (*OrgConfiguration, error)public OrgConfiguration(string name, OrgConfigurationArgs args, CustomResourceOptions? opts = null)
public OrgConfiguration(String name, OrgConfigurationArgs args)
public OrgConfiguration(String name, OrgConfigurationArgs args, CustomResourceOptions options)
type: okta:OrgConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args OrgConfigurationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args OrgConfigurationArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args OrgConfigurationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OrgConfigurationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args OrgConfigurationArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var orgConfigurationResource = new Okta.OrgConfiguration("orgConfigurationResource", new()
{
    CompanyName = "string",
    EndUserSupportHelpUrl = "string",
    OptOutCommunicationEmails = false,
    City = "string",
    Address2 = "string",
    Country = "string",
    Address1 = "string",
    Logo = "string",
    BillingContactUser = "string",
    PhoneNumber = "string",
    PostalCode = "string",
    State = "string",
    SupportPhoneNumber = "string",
    TechnicalContactUser = "string",
    Website = "string",
});
example, err := okta.NewOrgConfiguration(ctx, "orgConfigurationResource", &okta.OrgConfigurationArgs{
	CompanyName:               pulumi.String("string"),
	EndUserSupportHelpUrl:     pulumi.String("string"),
	OptOutCommunicationEmails: pulumi.Bool(false),
	City:                      pulumi.String("string"),
	Address2:                  pulumi.String("string"),
	Country:                   pulumi.String("string"),
	Address1:                  pulumi.String("string"),
	Logo:                      pulumi.String("string"),
	BillingContactUser:        pulumi.String("string"),
	PhoneNumber:               pulumi.String("string"),
	PostalCode:                pulumi.String("string"),
	State:                     pulumi.String("string"),
	SupportPhoneNumber:        pulumi.String("string"),
	TechnicalContactUser:      pulumi.String("string"),
	Website:                   pulumi.String("string"),
})
var orgConfigurationResource = new OrgConfiguration("orgConfigurationResource", OrgConfigurationArgs.builder()
    .companyName("string")
    .endUserSupportHelpUrl("string")
    .optOutCommunicationEmails(false)
    .city("string")
    .address2("string")
    .country("string")
    .address1("string")
    .logo("string")
    .billingContactUser("string")
    .phoneNumber("string")
    .postalCode("string")
    .state("string")
    .supportPhoneNumber("string")
    .technicalContactUser("string")
    .website("string")
    .build());
org_configuration_resource = okta.OrgConfiguration("orgConfigurationResource",
    company_name="string",
    end_user_support_help_url="string",
    opt_out_communication_emails=False,
    city="string",
    address2="string",
    country="string",
    address1="string",
    logo="string",
    billing_contact_user="string",
    phone_number="string",
    postal_code="string",
    state="string",
    support_phone_number="string",
    technical_contact_user="string",
    website="string")
const orgConfigurationResource = new okta.OrgConfiguration("orgConfigurationResource", {
    companyName: "string",
    endUserSupportHelpUrl: "string",
    optOutCommunicationEmails: false,
    city: "string",
    address2: "string",
    country: "string",
    address1: "string",
    logo: "string",
    billingContactUser: "string",
    phoneNumber: "string",
    postalCode: "string",
    state: "string",
    supportPhoneNumber: "string",
    technicalContactUser: "string",
    website: "string",
});
type: okta:OrgConfiguration
properties:
    address1: string
    address2: string
    billingContactUser: string
    city: string
    companyName: string
    country: string
    endUserSupportHelpUrl: string
    logo: string
    optOutCommunicationEmails: false
    phoneNumber: string
    postalCode: string
    state: string
    supportPhoneNumber: string
    technicalContactUser: string
    website: string
OrgConfiguration Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The OrgConfiguration resource accepts the following input properties:
- CompanyName string
- Name of org
- Address1 string
- Primary address of org
- Address2 string
- Secondary address of org
- BillingContact stringUser 
- User ID representing the billing contact
- City string
- City of org
- Country string
- Country of org
- EndUser stringSupport Help Url 
- Support link of org
- Logo string
- Logo of org. The file must be in PNG, JPG, or GIF format and less than 1 MB in size. For best results use landscape orientation, a transparent background, and a minimum size of 420px by 120px to prevent upscaling.
- OptOut boolCommunication Emails 
- Indicates whether the org's users receive Okta Communication emails
- PhoneNumber string
- Support help phone of org
- PostalCode string
- Postal code of org
- State string
- State of org
- SupportPhone stringNumber 
- Support help phone of org
- TechnicalContact stringUser 
- User ID representing the technical contact
- Website string
- The org's website
- CompanyName string
- Name of org
- Address1 string
- Primary address of org
- Address2 string
- Secondary address of org
- BillingContact stringUser 
- User ID representing the billing contact
- City string
- City of org
- Country string
- Country of org
- EndUser stringSupport Help Url 
- Support link of org
- Logo string
- Logo of org. The file must be in PNG, JPG, or GIF format and less than 1 MB in size. For best results use landscape orientation, a transparent background, and a minimum size of 420px by 120px to prevent upscaling.
- OptOut boolCommunication Emails 
- Indicates whether the org's users receive Okta Communication emails
- PhoneNumber string
- Support help phone of org
- PostalCode string
- Postal code of org
- State string
- State of org
- SupportPhone stringNumber 
- Support help phone of org
- TechnicalContact stringUser 
- User ID representing the technical contact
- Website string
- The org's website
- companyName String
- Name of org
- address1 String
- Primary address of org
- address2 String
- Secondary address of org
- billingContact StringUser 
- User ID representing the billing contact
- city String
- City of org
- country String
- Country of org
- endUser StringSupport Help Url 
- Support link of org
- logo String
- Logo of org. The file must be in PNG, JPG, or GIF format and less than 1 MB in size. For best results use landscape orientation, a transparent background, and a minimum size of 420px by 120px to prevent upscaling.
- optOut BooleanCommunication Emails 
- Indicates whether the org's users receive Okta Communication emails
- phoneNumber String
- Support help phone of org
- postalCode String
- Postal code of org
- state String
- State of org
- supportPhone StringNumber 
- Support help phone of org
- technicalContact StringUser 
- User ID representing the technical contact
- website String
- The org's website
- companyName string
- Name of org
- address1 string
- Primary address of org
- address2 string
- Secondary address of org
- billingContact stringUser 
- User ID representing the billing contact
- city string
- City of org
- country string
- Country of org
- endUser stringSupport Help Url 
- Support link of org
- logo string
- Logo of org. The file must be in PNG, JPG, or GIF format and less than 1 MB in size. For best results use landscape orientation, a transparent background, and a minimum size of 420px by 120px to prevent upscaling.
- optOut booleanCommunication Emails 
- Indicates whether the org's users receive Okta Communication emails
- phoneNumber string
- Support help phone of org
- postalCode string
- Postal code of org
- state string
- State of org
- supportPhone stringNumber 
- Support help phone of org
- technicalContact stringUser 
- User ID representing the technical contact
- website string
- The org's website
- company_name str
- Name of org
- address1 str
- Primary address of org
- address2 str
- Secondary address of org
- billing_contact_ struser 
- User ID representing the billing contact
- city str
- City of org
- country str
- Country of org
- end_user_ strsupport_ help_ url 
- Support link of org
- logo str
- Logo of org. The file must be in PNG, JPG, or GIF format and less than 1 MB in size. For best results use landscape orientation, a transparent background, and a minimum size of 420px by 120px to prevent upscaling.
- opt_out_ boolcommunication_ emails 
- Indicates whether the org's users receive Okta Communication emails
- phone_number str
- Support help phone of org
- postal_code str
- Postal code of org
- state str
- State of org
- support_phone_ strnumber 
- Support help phone of org
- technical_contact_ struser 
- User ID representing the technical contact
- website str
- The org's website
- companyName String
- Name of org
- address1 String
- Primary address of org
- address2 String
- Secondary address of org
- billingContact StringUser 
- User ID representing the billing contact
- city String
- City of org
- country String
- Country of org
- endUser StringSupport Help Url 
- Support link of org
- logo String
- Logo of org. The file must be in PNG, JPG, or GIF format and less than 1 MB in size. For best results use landscape orientation, a transparent background, and a minimum size of 420px by 120px to prevent upscaling.
- optOut BooleanCommunication Emails 
- Indicates whether the org's users receive Okta Communication emails
- phoneNumber String
- Support help phone of org
- postalCode String
- Postal code of org
- state String
- State of org
- supportPhone StringNumber 
- Support help phone of org
- technicalContact StringUser 
- User ID representing the technical contact
- website String
- The org's website
Outputs
All input properties are implicitly available as output properties. Additionally, the OrgConfiguration resource produces the following output properties:
- expires_at str
- Expiration of org
- id str
- The provider-assigned unique ID for this managed resource.
- subdomain str
- Subdomain of org
Look up Existing OrgConfiguration Resource
Get an existing OrgConfiguration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: OrgConfigurationState, opts?: CustomResourceOptions): OrgConfiguration@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address1: Optional[str] = None,
        address2: Optional[str] = None,
        billing_contact_user: Optional[str] = None,
        city: Optional[str] = None,
        company_name: Optional[str] = None,
        country: Optional[str] = None,
        end_user_support_help_url: Optional[str] = None,
        expires_at: Optional[str] = None,
        logo: Optional[str] = None,
        opt_out_communication_emails: Optional[bool] = None,
        phone_number: Optional[str] = None,
        postal_code: Optional[str] = None,
        state: Optional[str] = None,
        subdomain: Optional[str] = None,
        support_phone_number: Optional[str] = None,
        technical_contact_user: Optional[str] = None,
        website: Optional[str] = None) -> OrgConfigurationfunc GetOrgConfiguration(ctx *Context, name string, id IDInput, state *OrgConfigurationState, opts ...ResourceOption) (*OrgConfiguration, error)public static OrgConfiguration Get(string name, Input<string> id, OrgConfigurationState? state, CustomResourceOptions? opts = null)public static OrgConfiguration get(String name, Output<String> id, OrgConfigurationState state, CustomResourceOptions options)resources:  _:    type: okta:OrgConfiguration    get:      id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Address1 string
- Primary address of org
- Address2 string
- Secondary address of org
- BillingContact stringUser 
- User ID representing the billing contact
- City string
- City of org
- CompanyName string
- Name of org
- Country string
- Country of org
- EndUser stringSupport Help Url 
- Support link of org
- ExpiresAt string
- Expiration of org
- Logo string
- Logo of org. The file must be in PNG, JPG, or GIF format and less than 1 MB in size. For best results use landscape orientation, a transparent background, and a minimum size of 420px by 120px to prevent upscaling.
- OptOut boolCommunication Emails 
- Indicates whether the org's users receive Okta Communication emails
- PhoneNumber string
- Support help phone of org
- PostalCode string
- Postal code of org
- State string
- State of org
- Subdomain string
- Subdomain of org
- SupportPhone stringNumber 
- Support help phone of org
- TechnicalContact stringUser 
- User ID representing the technical contact
- Website string
- The org's website
- Address1 string
- Primary address of org
- Address2 string
- Secondary address of org
- BillingContact stringUser 
- User ID representing the billing contact
- City string
- City of org
- CompanyName string
- Name of org
- Country string
- Country of org
- EndUser stringSupport Help Url 
- Support link of org
- ExpiresAt string
- Expiration of org
- Logo string
- Logo of org. The file must be in PNG, JPG, or GIF format and less than 1 MB in size. For best results use landscape orientation, a transparent background, and a minimum size of 420px by 120px to prevent upscaling.
- OptOut boolCommunication Emails 
- Indicates whether the org's users receive Okta Communication emails
- PhoneNumber string
- Support help phone of org
- PostalCode string
- Postal code of org
- State string
- State of org
- Subdomain string
- Subdomain of org
- SupportPhone stringNumber 
- Support help phone of org
- TechnicalContact stringUser 
- User ID representing the technical contact
- Website string
- The org's website
- address1 String
- Primary address of org
- address2 String
- Secondary address of org
- billingContact StringUser 
- User ID representing the billing contact
- city String
- City of org
- companyName String
- Name of org
- country String
- Country of org
- endUser StringSupport Help Url 
- Support link of org
- expiresAt String
- Expiration of org
- logo String
- Logo of org. The file must be in PNG, JPG, or GIF format and less than 1 MB in size. For best results use landscape orientation, a transparent background, and a minimum size of 420px by 120px to prevent upscaling.
- optOut BooleanCommunication Emails 
- Indicates whether the org's users receive Okta Communication emails
- phoneNumber String
- Support help phone of org
- postalCode String
- Postal code of org
- state String
- State of org
- subdomain String
- Subdomain of org
- supportPhone StringNumber 
- Support help phone of org
- technicalContact StringUser 
- User ID representing the technical contact
- website String
- The org's website
- address1 string
- Primary address of org
- address2 string
- Secondary address of org
- billingContact stringUser 
- User ID representing the billing contact
- city string
- City of org
- companyName string
- Name of org
- country string
- Country of org
- endUser stringSupport Help Url 
- Support link of org
- expiresAt string
- Expiration of org
- logo string
- Logo of org. The file must be in PNG, JPG, or GIF format and less than 1 MB in size. For best results use landscape orientation, a transparent background, and a minimum size of 420px by 120px to prevent upscaling.
- optOut booleanCommunication Emails 
- Indicates whether the org's users receive Okta Communication emails
- phoneNumber string
- Support help phone of org
- postalCode string
- Postal code of org
- state string
- State of org
- subdomain string
- Subdomain of org
- supportPhone stringNumber 
- Support help phone of org
- technicalContact stringUser 
- User ID representing the technical contact
- website string
- The org's website
- address1 str
- Primary address of org
- address2 str
- Secondary address of org
- billing_contact_ struser 
- User ID representing the billing contact
- city str
- City of org
- company_name str
- Name of org
- country str
- Country of org
- end_user_ strsupport_ help_ url 
- Support link of org
- expires_at str
- Expiration of org
- logo str
- Logo of org. The file must be in PNG, JPG, or GIF format and less than 1 MB in size. For best results use landscape orientation, a transparent background, and a minimum size of 420px by 120px to prevent upscaling.
- opt_out_ boolcommunication_ emails 
- Indicates whether the org's users receive Okta Communication emails
- phone_number str
- Support help phone of org
- postal_code str
- Postal code of org
- state str
- State of org
- subdomain str
- Subdomain of org
- support_phone_ strnumber 
- Support help phone of org
- technical_contact_ struser 
- User ID representing the technical contact
- website str
- The org's website
- address1 String
- Primary address of org
- address2 String
- Secondary address of org
- billingContact StringUser 
- User ID representing the billing contact
- city String
- City of org
- companyName String
- Name of org
- country String
- Country of org
- endUser StringSupport Help Url 
- Support link of org
- expiresAt String
- Expiration of org
- logo String
- Logo of org. The file must be in PNG, JPG, or GIF format and less than 1 MB in size. For best results use landscape orientation, a transparent background, and a minimum size of 420px by 120px to prevent upscaling.
- optOut BooleanCommunication Emails 
- Indicates whether the org's users receive Okta Communication emails
- phoneNumber String
- Support help phone of org
- postalCode String
- Postal code of org
- state String
- State of org
- subdomain String
- Subdomain of org
- supportPhone StringNumber 
- Support help phone of org
- technicalContact StringUser 
- User ID representing the technical contact
- website String
- The org's website
Import
$ pulumi import okta:index/orgConfiguration:OrgConfiguration example _
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Okta pulumi/pulumi-okta
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the oktaTerraform Provider.
