Okta.Sdk.Api.BrandsApi

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

Method	HTTP request	Description
CreateBrand	POST /api/v1/brands	Create a Brand
DeleteBrand	DELETE /api/v1/brands/{brandId}	Delete a brand
GetBrand	GET /api/v1/brands/{brandId}	Retrieve a Brand
ListBrandDomains	GET /api/v1/brands/{brandId}/domains	List all Domains associated with a Brand
ListBrands	GET /api/v1/brands	List all Brands
ReplaceBrand	PUT /api/v1/brands/{brandId}	Replace a Brand

CreateBrand

Brand CreateBrand (CreateBrandRequest createBrandRequest = null)

Create a Brand

Creates a new brand in your org

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class CreateBrandExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BrandsApi(config);
            var createBrandRequest = new CreateBrandRequest(); // CreateBrandRequest |  (optional) 

            try
            {
                // Create a Brand
                Brand result = apiInstance.CreateBrand(createBrandRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BrandsApi.CreateBrand: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
createBrandRequest	CreateBrandRequest		[optional]

Return type

Brand

Authorization

apiToken, oauth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Successfully created the brand	-
400	Bad Request	-
403	Forbidden	-
409	Could not create the new brand because same name already exist.	-
429	Too Many Requests	-

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

DeleteBrand

void DeleteBrand (string brandId)

Delete a brand

Deletes a brand by brandId

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class DeleteBrandExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BrandsApi(config);
            var brandId = "brandId_example";  // string | The ID of the brand

            try
            {
                // Delete a brand
                apiInstance.DeleteBrand(brandId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BrandsApi.DeleteBrand: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
brandId	string	The ID of the brand

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Successfully deleted the brand.	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-
429	Too Many Requests	-

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

GetBrand

BrandWithEmbedded GetBrand (string brandId, List expand = null)

Retrieve a Brand

Retrieves a brand by brandId

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class GetBrandExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BrandsApi(config);
            var brandId = "brandId_example";  // string | The ID of the brand
            var expand = new List<string>(); // List<string> | Specifies additional metadata to be included in the response (optional) 

            try
            {
                // Retrieve a Brand
                BrandWithEmbedded result = apiInstance.GetBrand(brandId, expand);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BrandsApi.GetBrand: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
brandId	string	The ID of the brand
expand	List<string>	Specifies additional metadata to be included in the response	[optional]

Return type

BrandWithEmbedded

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved the brand	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

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

ListBrandDomains

List<DomainResponse> ListBrandDomains (string brandId)

List all Domains associated with a Brand

Lists all domains associated with a brand by brandId

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ListBrandDomainsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BrandsApi(config);
            var brandId = "brandId_example";  // string | The ID of the brand

            try
            {
                // List all Domains associated with a Brand
                List<DomainResponse> result = apiInstance.ListBrandDomains(brandId).ToListAsync();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BrandsApi.ListBrandDomains: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
brandId	string	The ID of the brand

Return type

List<DomainResponse>

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully returned the list of domains for the brand	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

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

ListBrands

List<BrandWithEmbedded> ListBrands (List expand = null, string after = null, int? limit = null, string q = null)

List all Brands

Lists all the brands in your org

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ListBrandsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BrandsApi(config);
            var expand = new List<string>(); // List<string> | Specifies additional metadata to be included in the response (optional) 
            var 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) 
            var limit = 20;  // int? | A limit on the number of objects to return (optional)  (default to 20)
            var q = "q_example";  // string | Searches the records for matching value (optional) 

            try
            {
                // List all Brands
                List<BrandWithEmbedded> result = apiInstance.ListBrands(expand, after, limit, q).ToListAsync();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BrandsApi.ListBrands: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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

Return type

List<BrandWithEmbedded>

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully returned the list of brands	-
403	Forbidden	-
429	Too Many Requests	-

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

ReplaceBrand

Brand ReplaceBrand (string brandId, BrandRequest brand)

Replace a 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.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ReplaceBrandExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BrandsApi(config);
            var brandId = "brandId_example";  // string | The ID of the brand
            var brand = new BrandRequest(); // BrandRequest | 

            try
            {
                // Replace a Brand
                Brand result = apiInstance.ReplaceBrand(brandId, brand);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BrandsApi.ReplaceBrand: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
brandId	string	The ID of the brand
brand	BrandRequest

Return type

Brand

Authorization

apiToken, oauth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successfully replaced the brand	-
400	Bad Request	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

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

Files

BrandsApi.md

Latest commit

History

BrandsApi.md

File metadata and controls

Okta.Sdk.Api.BrandsApi

CreateBrand

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeleteBrand

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetBrand

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ListBrandDomains

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ListBrands

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ReplaceBrand

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details