Skip to content

Latest commit

 

History

History
208 lines (158 loc) · 6.23 KB

BrandingServiceSmtpApi.md

File metadata and controls

208 lines (158 loc) · 6.23 KB
Raw

BrandingServiceSmtpApi

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

Method HTTP request Description
deleteEmailSettings DELETE /api/2/branding/email_settings Delete Custom Email Settings
getEmailSettings GET /api/2/branding/email_settings Get Email Settings
updateEmailSettings PUT /api/2/branding/email_settings Update Email Settings

deleteEmailSettings

AltErr deleteEmailSettings()

Delete Custom Email Settings

Reset Email Setting config

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.BrandingServiceSmtpApi;

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");

    BrandingServiceSmtpApi apiInstance = new BrandingServiceSmtpApi(defaultClient);
    try {
      AltErr result = apiInstance.deleteEmailSettings();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling BrandingServiceSmtpApi#deleteEmailSettings");
      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

AltErr

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 -

getEmailSettings

GetEmailSettings200Response getEmailSettings()

Get Email Settings

Get Email Settings Config

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.BrandingServiceSmtpApi;

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");

    BrandingServiceSmtpApi apiInstance = new BrandingServiceSmtpApi(defaultClient);
    try {
      GetEmailSettings200Response result = apiInstance.getEmailSettings();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling BrandingServiceSmtpApi#getEmailSettings");
      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

GetEmailSettings200Response

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 -

updateEmailSettings

AltErr updateEmailSettings(emailConfig)

Update Email Settings

Update Email Settings Config

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.BrandingServiceSmtpApi;

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");

    BrandingServiceSmtpApi apiInstance = new BrandingServiceSmtpApi(defaultClient);
    EmailConfig emailConfig = new EmailConfig(); // EmailConfig | 
    try {
      AltErr result = apiInstance.updateEmailSettings(emailConfig);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling BrandingServiceSmtpApi#updateEmailSettings");
      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
emailConfig EmailConfig [optional]

Return type

AltErr

Authorization

OAuth2

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful response -
401 Unauthorized -
422 Unprocessable Entity -