API version:
Show / Hide Table of Contents

Interface IProfileMappingsClient

A client that works with Okta ProfileMapping resources.

Namespace: Okta.Sdk
Assembly: Okta.Sdk.dll
Syntax
public interface IProfileMappingsClient

Methods

GetProfileMappingAsync(String, CancellationToken)

Fetches a single Profile Mapping referenced by its ID.

Declaration
Task<IProfileMapping> GetProfileMappingAsync(string mappingId, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
System.String mappingId
System.Threading.CancellationToken cancellationToken

The cancellation token.

Returns
Type Description
System.Threading.Tasks.Task<IProfileMapping>

The IProfileMapping response.

ListProfileMappings(String, Nullable<Int32>, String, String)

Enumerates Profile Mappings in your organization with pagination.

Declaration
ICollectionClient<IProfileMapping> ListProfileMappings(string after = null, int? limit, string sourceId = null, string targetId = "")
Parameters
Type Name Description
System.String after
System.Nullable<System.Int32> limit
System.String sourceId
System.String targetId
Returns
Type Description
ICollectionClient<IProfileMapping>

A collection of IProfileMapping that can be enumerated asynchronously.

UpdateProfileMappingAsync(IProfileMapping, String, CancellationToken)

Updates an existing Profile Mapping by adding, updating, or removing one or many Property Mappings.

Declaration
Task<IProfileMapping> UpdateProfileMappingAsync(IProfileMapping profileMapping, string mappingId, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IProfileMapping profileMapping

The IProfileMapping resource.

System.String mappingId
System.Threading.CancellationToken cancellationToken

The cancellation token.

Returns
Type Description
System.Threading.Tasks.Task<IProfileMapping>

The IProfileMapping response.

Back to top Copyright © 2021 Okta, Inc.
Generated with DocFx.