Package com.okta.sdk.resource.api
Class ApplicationLogosApi
java.lang.Object
com.okta.sdk.resource.api.ApplicationLogosApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2024-08-09T14:19:33.269913-05:00[America/Chicago]",
comments="Generator version: 7.7.0")
public class ApplicationLogosApi
extends Object
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected static com.fasterxml.jackson.databind.ObjectMapper
void
setApiClient
(ApiClient apiClient) void
uploadApplicationLogo
(String appId, File _file) Upload an application Logo Uploads a logo for the app instance.void
Upload an application Logo Uploads a logo for the app instance.
-
Constructor Details
-
ApplicationLogosApi
public ApplicationLogosApi() -
ApplicationLogosApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
uploadApplicationLogo
Upload an application Logo Uploads a logo for the app instance. If the app already has a logo, this operation replaces the previous logo. The logo is visible in the Admin Console as an icon for your app instance. If you have one `appLink` object configured, this logo also appears in the End-User Dashboard as an icon for your app. > **Note:** If you have multiple `appLink` objects, use the Admin Console to add logos for each app link. > You can't use the API to add logos for multiple app links.- Parameters:
appId
- Application ID (required)_file
- The image file containing the logo. The file must be in PNG, JPG, SVG, or GIF format, and less than one MB in size. For best results, use an image with a transparent background and a square dimension of 200 x 200 pixels to prevent upscaling. (required)- Throws:
ApiException
- if fails to make API call
-
uploadApplicationLogo
public void uploadApplicationLogo(String appId, File _file, Map<String, String> additionalHeaders) throws ApiExceptionUpload an application Logo Uploads a logo for the app instance. If the app already has a logo, this operation replaces the previous logo. The logo is visible in the Admin Console as an icon for your app instance. If you have one `appLink` object configured, this logo also appears in the End-User Dashboard as an icon for your app. > **Note:** If you have multiple `appLink` objects, use the Admin Console to add logos for each app link. > You can't use the API to add logos for multiple app links.- Parameters:
appId
- Application ID (required)_file
- The image file containing the logo. The file must be in PNG, JPG, SVG, or GIF format, and less than one MB in size. For best results, use an image with a transparent background and a square dimension of 200 x 200 pixels to prevent upscaling. (required)additionalHeaders
- additionalHeaders for this call- Throws:
ApiException
- if fails to make API call
-
getObjectMapper
protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()
-