Skip to content

Latest commit

 

History

History
423 lines (324 loc) · 12.4 KB

BrandingServiceApi.md

File metadata and controls

423 lines (324 loc) · 12.4 KB
Raw

BrandingServiceApi

All URIs are relative to https://your-api-subdomain.onelogin.com

Method HTTP request Description
createBrand POST /api/2/branding/brands Create Brand
deleteBrand DELETE /api/2/branding/brands/{brand_id} Delete Brand
getBrand GET /api/2/branding/brands/{brand_id} Get Brand
getBrandApps GET /api/2/branding/brands/{brand_id}/apps Get Brand Apps
listBrands GET /api/2/branding/brands List Account Brands
updateBrand PUT /api/2/branding/brands/{brand_id} Update Brand

createBrand

Brand createBrand(brand)

Create Brand

Create a new Account Brand

Example

// Import classes:
import com.onelogin.client.ApiClient;
import com.onelogin.client.ApiException;
import com.onelogin.client.Configuration;
import com.onelogin.client.auth.*;
import com.onelogin.client.models.*;
import com.onelogin.client.api.BrandingServiceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://your-api-subdomain.onelogin.com");
    
    // Configure OAuth2 access token for authorization: OAuth2
    OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
    OAuth2.setAccessToken("YOUR ACCESS TOKEN");

    BrandingServiceApi apiInstance = new BrandingServiceApi(defaultClient);
    Brand brand = new Brand(); // Brand | 
    try {
      Brand result = apiInstance.createBrand(brand);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling BrandingServiceApi#createBrand");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
brand Brand [optional]

Return type

Brand

Authorization

OAuth2

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 Created -
401 Unauthorized -
422 Unprocessable Entity -

deleteBrand

deleteBrand(brandId)

Delete Brand

Delete Brand

Example

// Import classes:
import com.onelogin.client.ApiClient;
import com.onelogin.client.ApiException;
import com.onelogin.client.Configuration;
import com.onelogin.client.auth.*;
import com.onelogin.client.models.*;
import com.onelogin.client.api.BrandingServiceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://your-api-subdomain.onelogin.com");
    
    // Configure OAuth2 access token for authorization: OAuth2
    OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
    OAuth2.setAccessToken("YOUR ACCESS TOKEN");

    BrandingServiceApi apiInstance = new BrandingServiceApi(defaultClient);
    Integer brandId = 9; // Integer | Unique identifier for the branding object.
    try {
      apiInstance.deleteBrand(brandId);
    } catch (ApiException e) {
      System.err.println("Exception when calling BrandingServiceApi#deleteBrand");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
brandId Integer Unique identifier for the branding object.

Return type

null (empty response body)

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
204 No Content -
401 Unauthorized -
404 Not Found -

getBrand

Brand getBrand(brandId)

Get Brand

Retrieve a single brand via ID

Example

// Import classes:
import com.onelogin.client.ApiClient;
import com.onelogin.client.ApiException;
import com.onelogin.client.Configuration;
import com.onelogin.client.auth.*;
import com.onelogin.client.models.*;
import com.onelogin.client.api.BrandingServiceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://your-api-subdomain.onelogin.com");
    
    // Configure OAuth2 access token for authorization: OAuth2
    OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
    OAuth2.setAccessToken("YOUR ACCESS TOKEN");

    BrandingServiceApi apiInstance = new BrandingServiceApi(defaultClient);
    Integer brandId = 9; // Integer | Unique identifier for the branding object.
    try {
      Brand result = apiInstance.getBrand(brandId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling BrandingServiceApi#getBrand");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
brandId Integer Unique identifier for the branding object.

Return type

Brand

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
401 Unauthorized -
404 Not Found -

getBrandApps

List<BrandApp> getBrandApps(brandId)

Get Brand Apps

Get Apps Associated with Account Brand

Example

// Import classes:
import com.onelogin.client.ApiClient;
import com.onelogin.client.ApiException;
import com.onelogin.client.Configuration;
import com.onelogin.client.auth.*;
import com.onelogin.client.models.*;
import com.onelogin.client.api.BrandingServiceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://your-api-subdomain.onelogin.com");
    
    // Configure OAuth2 access token for authorization: OAuth2
    OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
    OAuth2.setAccessToken("YOUR ACCESS TOKEN");

    BrandingServiceApi apiInstance = new BrandingServiceApi(defaultClient);
    Integer brandId = 9; // Integer | Unique identifier for the branding object.
    try {
      List<BrandApp> result = apiInstance.getBrandApps(brandId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling BrandingServiceApi#getBrandApps");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
brandId Integer Unique identifier for the branding object.

Return type

List<BrandApp>

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
401 Unauthorized -
404 Not Found -

listBrands

List<BrandReq> listBrands()

List Account Brands

List Account Brands

Example

// Import classes:
import com.onelogin.client.ApiClient;
import com.onelogin.client.ApiException;
import com.onelogin.client.Configuration;
import com.onelogin.client.auth.*;
import com.onelogin.client.models.*;
import com.onelogin.client.api.BrandingServiceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://your-api-subdomain.onelogin.com");
    
    // Configure OAuth2 access token for authorization: OAuth2
    OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
    OAuth2.setAccessToken("YOUR ACCESS TOKEN");

    BrandingServiceApi apiInstance = new BrandingServiceApi(defaultClient);
    try {
      List<BrandReq> result = apiInstance.listBrands();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling BrandingServiceApi#listBrands");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

List<BrandReq>

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -

updateBrand

Brand updateBrand(brandId, requestBrand)

Update Brand

Update Account Brand

Example

// Import classes:
import com.onelogin.client.ApiClient;
import com.onelogin.client.ApiException;
import com.onelogin.client.Configuration;
import com.onelogin.client.auth.*;
import com.onelogin.client.models.*;
import com.onelogin.client.api.BrandingServiceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://your-api-subdomain.onelogin.com");
    
    // Configure OAuth2 access token for authorization: OAuth2
    OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
    OAuth2.setAccessToken("YOUR ACCESS TOKEN");

    BrandingServiceApi apiInstance = new BrandingServiceApi(defaultClient);
    Integer brandId = 9; // Integer | Unique identifier for the branding object.
    RequestBrand requestBrand = new RequestBrand(); // RequestBrand | 
    try {
      Brand result = apiInstance.updateBrand(brandId, requestBrand);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling BrandingServiceApi#updateBrand");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
brandId Integer Unique identifier for the branding object.
requestBrand RequestBrand [optional]

Return type

Brand

Authorization

OAuth2

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 Created -
401 Unauthorized -
422 Unprocessable Entity -