Class UserSchemasClient

A client that communicates with the Okta management API.

Inheritance

System.Object

OktaClient

UserSchemasClient

Implements

IOktaClient

IUserSchemasClient

Inherited Members

OktaClient.Configuration

OktaClient.CreateScoped(RequestContext)

OktaClient.UserTypes

OktaClient.Users

OktaClient.UserFactors

OktaClient.Groups

OktaClient.Applications

OktaClient.Sessions

OktaClient.AuthorizationServers

OktaClient.Logs

OktaClient.Policies

OktaClient.EventHooks

OktaClient.InlineHooks

OktaClient.LinkedObjects

OktaClient.TrustedOrigins

OktaClient.Features

OktaClient.Templates

OktaClient.NetworkZones

OktaClient.Domains

OktaClient.IdentityProviders

OktaClient.UserSchemas

OktaClient.GetCollectionClient<T>(HttpRequest)

OktaClient.GetAsync<T>(String, CancellationToken)

OktaClient.GetAsync<T>(HttpRequest, CancellationToken)

OktaClient.GetCollection<T>(String)

OktaClient.GetCollection<T>(HttpRequest)

OktaClient.PostAsync(String, Object, CancellationToken)

OktaClient.PostAsync<TResponse>(String, Object, CancellationToken)

OktaClient.PostAsync(HttpRequest, CancellationToken)

OktaClient.PostAsync<TResponse>(HttpRequest, CancellationToken)

OktaClient.PutAsync(String, Object, CancellationToken)

OktaClient.PutAsync<TResponse>(String, Object, CancellationToken)

OktaClient.PutAsync(HttpRequest, CancellationToken)

OktaClient.PutAsync<TResponse>(HttpRequest, CancellationToken)

OktaClient.DeleteAsync(String, CancellationToken)

OktaClient.DeleteAsync(HttpRequest, CancellationToken)

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Okta.Sdk

Assembly: Okta.Sdk.dll

Syntax

public sealed class UserSchemasClient : OktaClient, IOktaClient, IUserSchemasClient

Methods

GetApplicationUserSchemaAsync(String, CancellationToken)

Fetches the Schema for an App User

Declaration

public 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

public 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

public 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

public 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.

Implements

IOktaClient

IUserSchemasClient