com.okta.sdk.resource.api

Class ProfileMappingApi

java.lang.Object

com.okta.sdk.resource.api.ProfileMappingApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-08-21T16:09:06.047-05:00[America/Chicago]")
public class ProfileMappingApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ProfileMappingApi()
ProfileMappingApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
ProfileMapping	getProfileMapping(String mappingId) Retrieve a Profile Mapping Retrieves a single Profile Mapping referenced by its ID
ProfileMapping	getProfileMapping(String mappingId, Map<String,String> additionalHeaders) Retrieve a Profile Mapping Retrieves a single Profile Mapping referenced by its ID
List<ListProfileMappings>	listProfileMappings(String after, Integer limit, String sourceId, String targetId) List all Profile Mappings Lists all profile mappings in your organization with [pagination](https://developer.okta.com/docs/api/#pagination).
List<ListProfileMappings>	listProfileMappings(String after, Integer limit, String sourceId, String targetId, Map<String,String> additionalHeaders) List all Profile Mappings Lists all profile mappings in your organization with [pagination](https://developer.okta.com/docs/api/#pagination).
void	setApiClient(ApiClient apiClient)
ProfileMapping	updateProfileMapping(String mappingId, ProfileMappingRequest profileMapping) Update a Profile Mapping Updates an existing profile mapping by adding, updating, or removing one or many property mappings
ProfileMapping	updateProfileMapping(String mappingId, ProfileMappingRequest profileMapping, Map<String,String> additionalHeaders) Update a Profile Mapping Updates an existing profile mapping by adding, updating, or removing one or many property mappings

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProfileMappingApi

public ProfileMappingApi()

ProfileMappingApi

public ProfileMappingApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getProfileMapping

public ProfileMapping getProfileMapping(String mappingId)
                                 throws ApiException

Retrieve a Profile Mapping Retrieves a single Profile Mapping referenced by its ID

Parameters:

mappingId - `id` of the Mapping (required)

Returns:

ProfileMapping

Throws:

ApiException - if fails to make API call

getProfileMapping

public ProfileMapping getProfileMapping(String mappingId,
                                        Map<String,String> additionalHeaders)
                                 throws ApiException

Retrieve a Profile Mapping Retrieves a single Profile Mapping referenced by its ID

Parameters:

mappingId - `id` of the Mapping (required)

additionalHeaders - additionalHeaders for this call

Returns:

ProfileMapping

Throws:

ApiException - if fails to make API call

listProfileMappings

public List<ListProfileMappings> listProfileMappings(String after,
                                                     Integer limit,
                                                     String sourceId,
                                                     String targetId)
                                              throws ApiException

List all Profile Mappings Lists all profile mappings in your organization with [pagination](https://developer.okta.com/docs/api/#pagination). You can return a subset of profile mappings that match a supported `sourceId` and/or `targetId`. The results are [paginated](/#pagination) according to the limit parameter. If there are multiple pages of results, the Link header contains a `next` link that should be treated as an opaque value (follow it, don't parse it). The response is a collection of profile mappings that include a subset of the profile mapping object's parameters. The profile mapping object describes the properties mapping between an Okta User and an App User Profile using [JSON Schema Draft 4](https://datatracker.ietf.org/doc/html/draft-zyp-json-schema-04).

Parameters:

after - Mapping `id` that specifies the pagination cursor for the next page of mappings (optional)

limit - Specifies the number of results per page (maximum 200) (optional, default to 20)

sourceId - The UserType or App Instance `id` that acts as the source of expressions in a mapping. If this parameter is included, all returned mappings have this as their `source.id`. (optional)

targetId - The UserType or App Instance `id` that acts as the target of expressions in a mapping. If this parameter is included, all returned mappings have this as their `target.id`. (optional)

Returns:

List<ListProfileMappings>

Throws:

ApiException - if fails to make API call

listProfileMappings

public List<ListProfileMappings> listProfileMappings(String after,
                                                     Integer limit,
                                                     String sourceId,
                                                     String targetId,
                                                     Map<String,String> additionalHeaders)
                                              throws ApiException

List all Profile Mappings Lists all profile mappings in your organization with [pagination](https://developer.okta.com/docs/api/#pagination). You can return a subset of profile mappings that match a supported `sourceId` and/or `targetId`. The results are [paginated](/#pagination) according to the limit parameter. If there are multiple pages of results, the Link header contains a `next` link that should be treated as an opaque value (follow it, don't parse it). The response is a collection of profile mappings that include a subset of the profile mapping object's parameters. The profile mapping object describes the properties mapping between an Okta User and an App User Profile using [JSON Schema Draft 4](https://datatracker.ietf.org/doc/html/draft-zyp-json-schema-04).

Parameters:

after - Mapping `id` that specifies the pagination cursor for the next page of mappings (optional)

limit - Specifies the number of results per page (maximum 200) (optional, default to 20)

sourceId - The UserType or App Instance `id` that acts as the source of expressions in a mapping. If this parameter is included, all returned mappings have this as their `source.id`. (optional)

targetId - The UserType or App Instance `id` that acts as the target of expressions in a mapping. If this parameter is included, all returned mappings have this as their `target.id`. (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<ListProfileMappings>

Throws:

ApiException - if fails to make API call

updateProfileMapping

public ProfileMapping updateProfileMapping(String mappingId,
                                           ProfileMappingRequest profileMapping)
                                    throws ApiException

Update a Profile Mapping Updates an existing profile mapping by adding, updating, or removing one or many property mappings

Parameters:

mappingId - `id` of the Mapping (required)

profileMapping - (required)

Returns:

ProfileMapping

Throws:

ApiException - if fails to make API call

updateProfileMapping

public ProfileMapping updateProfileMapping(String mappingId,
                                           ProfileMappingRequest profileMapping,
                                           Map<String,String> additionalHeaders)
                                    throws ApiException

Update a Profile Mapping Updates an existing profile mapping by adding, updating, or removing one or many property mappings

Parameters:

mappingId - `id` of the Mapping (required)

profileMapping - (required)

additionalHeaders - additionalHeaders for this call

Returns:

ProfileMapping

Throws:

ApiException - if fails to make API call

getObjectMapper

protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()