Interface IUserSchemasClient

A client that works with Okta UserSchema resources.

Namespace: Okta.Sdk

Assembly: Okta.Sdk.dll

Syntax

public interface IUserSchemasClient

Methods

GetApplicationUserSchemaAsync(String, CancellationToken)

Fetches the Schema for an App User

Declaration

Task<IUserSchema> GetApplicationUserSchemaAsync(string appInstanceId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	appInstanceId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<IUserSchema>	The IUserSchema response.

GetUserSchemaAsync(String, CancellationToken)

Fetches the schema for a Schema Id.

Declaration

Task<IUserSchema> GetUserSchemaAsync(string schemaId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	schemaId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<IUserSchema>	The IUserSchema response.

UpdateApplicationUserProfileAsync(IUserSchema, String, CancellationToken)

Partial updates on the User Profile properties of the Application User Schema.

Declaration

Task<IUserSchema> UpdateApplicationUserProfileAsync(IUserSchema body, string appInstanceId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
IUserSchema	body	The IUserSchema resource.
System.String	appInstanceId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<IUserSchema>	The IUserSchema response.

UpdateUserProfileAsync(IUserSchema, String, CancellationToken)

Partial updates on the User Profile properties of the user schema.

Declaration

Task<IUserSchema> UpdateUserProfileAsync(IUserSchema userSchema, string schemaId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
IUserSchema	userSchema	The IUserSchema resource.
System.String	schemaId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<IUserSchema>	The IUserSchema response.