Module: Auth0::Api::V2::Branding

Included in:

Auth0::Api::V2

Defined in:

lib/auth0/api/v2/branding.rb

Overview

Methods to use the branding endpoints

Instance Method Summary

• #branding ⇒ json (also: #get_branding)

  Retrieve branding settings.

• #branding_templates_for_universal_login ⇒ json (also: #get_branding_templates_for_universal_login)

  Get template for New Universal Login Experience.

• #delete_branding_templates_for_universal_login ⇒ Object

  Delete template for New Universal Login Experience.

• #patch_branding(body = {}) ⇒ json (also: #update_branding)

  Update branding settings.

• #put_branding_templates_for_universal_login(body = {}) ⇒ json (also: #set_branding_templates_for_universal_login)

  Set template for New Universal Login Experience.

Instance Method Details

#branding ⇒ json Also known as: get_branding

Retrieve branding settings.

Returns:

• (json) —

  Returns branding settings.

See Also:

• https://auth0.com/docs/api/management/v2/#!/Branding/get_branding

# File 'lib/auth0/api/v2/branding.rb', line 12

def branding()
  get(branding_path)
end

#branding_templates_for_universal_login ⇒ json Also known as: get_branding_templates_for_universal_login

Get template for New Universal Login Experience

Returns:

• (json) —

  Returns branding settings.

See Also:

• https://auth0.com/docs/api/management/v2/#!/Branding/get_universal_login

# File 'lib/auth0/api/v2/branding.rb', line 31

def branding_templates_for_universal_login
  get(templates_path)
end

#delete_branding_templates_for_universal_login ⇒ Object

Delete template for New Universal Login Experience

See Also:

• https://auth0.com/docs/api/management/v2/#!/Branding/delete_universal_login

# File 'lib/auth0/api/v2/branding.rb', line 38

def delete_branding_templates_for_universal_login
  delete(templates_path)
end

#patch_branding(body = {}) ⇒ json Also known as: update_branding

Update branding settings.

Parameters:

• body (hash) (defaults to: {}) —

  the branding settings to update

Returns:

• (json) —

  Returns branding settings.

See Also:

• https://auth0.com/docs/api/management/v2/#!/Branding/patch_branding

# File 'lib/auth0/api/v2/branding.rb', line 22

def patch_branding(body = {})
  patch(branding_path, body)
end

#put_branding_templates_for_universal_login(body = {}) ⇒ json Also known as: set_branding_templates_for_universal_login

Set template for New Universal Login Experience

Parameters:

• body (hash) (defaults to: {}) —

  the branding settings to update

Returns:

• (json) —

  Returns branding settings.

See Also:

• https://auth0.com/docs/api/management/v2/#!/Branding/put_universal_login

# File 'lib/auth0/api/v2/branding.rb', line 47

def put_branding_templates_for_universal_login(body = {})
  put(templates_path, body)
end