brands

Creates, updates, deletes, gets or lists a brands resource.

Overview

Name	brands
Type	Resource
Id	okta.brands.brands

Fields

The following fields are returned by SELECT queries:

list_brands

Successfully returned the list of brands

Name	Datatype	Description
id	string	The Brand ID
name	string	The name of the Brand
agreeToCustomPrivacyPolicy	boolean	Consent for updating the custom privacy URL. Not required when resetting the URL.
customPrivacyPolicyUrl	string	Custom privacy policy URL
defaultApp	object
emailDomainId	string	The ID of the email domain
isDefault	boolean	If true, the Brand is used for the Okta subdomain
locale	string	The language specified as an IETF BCP 47 language tag
removePoweredByOkta	boolean	Removes "Powered by Okta" from the sign-in page in redirect authentication deployments, and "© [current year] Okta, Inc." from the Okta End-User Dashboard

get_brand

Successfully retrieved the brand

Name	Datatype	Description
id	string	The Brand ID
name	string	The name of the Brand
agreeToCustomPrivacyPolicy	boolean	Consent for updating the custom privacy URL. Not required when resetting the URL.
customPrivacyPolicyUrl	string	Custom privacy policy URL
defaultApp	object
emailDomainId	string	The ID of the email domain
isDefault	boolean	If true, the Brand is used for the Okta subdomain
locale	string	The language specified as an IETF BCP 47 language tag
removePoweredByOkta	boolean	Removes "Powered by Okta" from the sign-in page in redirect authentication deployments, and "© [current year] Okta, Inc." from the Okta End-User Dashboard

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_brands	select	subdomain	expand, after, limit, q	Lists all the brands in your org
get_brand	select	subdomain	expand	Retrieves a brand by brandId
create_brand	insert	subdomain, data__name		Creates a new brand in your org
replace_brand	replace	subdomain, data__name		Replaces a brand by brandId Passing an invalid brandId returns a 404 Not Found status code with the error code E0000007. Not providing agreeToCustomPrivacyPolicy with customPrivacyPolicyUrl returns a 400 Bad Request status code with the error code E0000001.
delete_brand	delete	subdomain		Deletes a brand by brandId

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
subdomain	string	The domain of your organization. This can be a provided subdomain of an official okta domain (okta.com, oktapreview.com, etc) or one of your configured custom domains. (default: my-org)
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.
expand	array	Specifies additional metadata to be included in the response
limit	integer	A limit on the number of objects to return
q	string	Searches the records for matching value

SELECT examples

list_brands

Lists all the brands in your org

SELECT
id,
name,
agreeToCustomPrivacyPolicy,
customPrivacyPolicyUrl,
defaultApp,
emailDomainId,
isDefault,
locale,
removePoweredByOkta
FROM okta.brands.brands
WHERE subdomain = '{{ subdomain }}' -- required
AND expand = '{{ expand }}'
AND after = '{{ after }}'
AND limit = '{{ limit }}'
AND q = '{{ q }}'
;

get_brand

Retrieves a brand by brandId

SELECT
id,
name,
agreeToCustomPrivacyPolicy,
customPrivacyPolicyUrl,
defaultApp,
emailDomainId,
isDefault,
locale,
removePoweredByOkta
FROM okta.brands.brands
WHERE subdomain = '{{ subdomain }}' -- required
AND expand = '{{ expand }}'
;

INSERT examples

create_brand

Creates a new brand in your org

INSERT INTO okta.brands.brands (
data__name,
subdomain
)
SELECT 
'{{ name }}' /* required */,
'{{ subdomain }}'
RETURNING
id,
name,
agreeToCustomPrivacyPolicy,
customPrivacyPolicyUrl,
defaultApp,
emailDomainId,
isDefault,
locale,
removePoweredByOkta
;

Manifest

# Description fields are for documentation purposes
- name: brands
  props:
    - name: subdomain
      value: string
      description: Required parameter for the brands resource.
    - name: name
      value: string
      description: >
        The name of the Brand
        

REPLACE examples

replace_brand

Replaces a brand by brandId

Passing an invalid brandId returns a 404 Not Found status code with the error code E0000007.

Not providing agreeToCustomPrivacyPolicy with customPrivacyPolicyUrl returns a 400 Bad Request status code with the error code E0000001.

REPLACE okta.brands.brands
SET 
data__agreeToCustomPrivacyPolicy = {{ agreeToCustomPrivacyPolicy }},
data__customPrivacyPolicyUrl = '{{ customPrivacyPolicyUrl }}',
data__defaultApp = '{{ defaultApp }}',
data__emailDomainId = '{{ emailDomainId }}',
data__locale = '{{ locale }}',
data__name = '{{ name }}',
data__removePoweredByOkta = {{ removePoweredByOkta }}
WHERE 
subdomain = '{{ subdomain }}' --required
AND data__name = '{{ name }}' --required
RETURNING
id,
name,
agreeToCustomPrivacyPolicy,
customPrivacyPolicyUrl,
defaultApp,
emailDomainId,
isDefault,
locale,
removePoweredByOkta
;

DELETE examples

delete_brand

Deletes a brand by brandId

DELETE FROM okta.brands.brands
WHERE subdomain = '{{ subdomain }}' --required
;