Class ApplicationsClient

A client that communicates with the Okta management API.

Inheritance

System.Object

OktaClient

ApplicationsClient

Implements

IOktaClient

IApplicationsClient

System.Collections.Generic.IAsyncEnumerable<IApplication>

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 ApplicationsClient : OktaClient, IOktaClient, IApplicationsClient, IAsyncEnumerable<IApplication>

Methods

ActivateApplicationAsync(String, CancellationToken)

Activates an inactive application.

Declaration

public Task ActivateApplicationAsync(string appId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task	A Task that represents the asynchronous operation.

AssignUserToApplicationAsync(AssignUserToApplicationOptions, CancellationToken)

Assigns a user to an application

Declaration

public Task<IAppUser> AssignUserToApplicationAsync(AssignUserToApplicationOptions options, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
AssignUserToApplicationOptions	options	The assignment options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IAppUser>	The IApplication response.

AssignUserToApplicationAsync(IAppUser, String, CancellationToken)

Assigns an user to an application with credentials and an app-specific profile. Profile mappings defined for the application are first applied before applying any profile properties specified in the request.

Declaration

public Task<IAppUser> AssignUserToApplicationAsync(IAppUser appUser, string appId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
IAppUser	appUser	The IAppUser resource.
System.String	appId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

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

CloneApplicationKeyAsync(String, String, String, CancellationToken)

Clones a X.509 certificate for an application key credential from a source application to target application.

Declaration

public Task<IJsonWebKey> CloneApplicationKeyAsync(string appId, string keyId, string targetAid, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	appId
System.String	keyId
System.String	targetAid	Unique key of the target Application
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

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

CreateApplicationAsync(CreateBasicAuthApplicationOptions, CancellationToken)

Adds a basic authentication application

Declaration

public Task<IApplication> CreateApplicationAsync(CreateBasicAuthApplicationOptions basicAuthApplicationOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
CreateBasicAuthApplicationOptions	basicAuthApplicationOptions	The application options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

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

CreateApplicationAsync(CreateBookmarkApplicationOptions, CancellationToken)

Adds a bookmark application

Declaration

public Task<IApplication> CreateApplicationAsync(CreateBookmarkApplicationOptions bookmarkApplicationOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
CreateBookmarkApplicationOptions	bookmarkApplicationOptions	The application options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

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

CreateApplicationAsync(CreateOpenIdConnectApplication, CancellationToken)

Adds an OpenID Connect application

Declaration

public Task<IApplication> CreateApplicationAsync(CreateOpenIdConnectApplication openIdApplicationOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
CreateOpenIdConnectApplication	openIdApplicationOptions	The application options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

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

CreateApplicationAsync(CreateSamlApplicationOptions, CancellationToken)

Adds a SAML application

Declaration

public Task<IApplication> CreateApplicationAsync(CreateSamlApplicationOptions samlApplicationOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
CreateSamlApplicationOptions	samlApplicationOptions	The application options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

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

CreateApplicationAsync(CreateSwaApplicationOptions, CancellationToken)

Adds a SWA application

Declaration

public Task<IApplication> CreateApplicationAsync(CreateSwaApplicationOptions swaApplicationOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
CreateSwaApplicationOptions	swaApplicationOptions	The app
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

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

CreateApplicationAsync(CreateSwaCustomApplicationOptions, CancellationToken)

Adds a SWA custom application

Declaration

public Task<IApplication> CreateApplicationAsync(CreateSwaCustomApplicationOptions swaCustomApplicationOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
CreateSwaCustomApplicationOptions	swaCustomApplicationOptions	The application options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

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

CreateApplicationAsync(CreateSwaNoPluginApplicationOptions, CancellationToken)

Adds a SWA no-plugin application

Declaration

public Task<IApplication> CreateApplicationAsync(CreateSwaNoPluginApplicationOptions swaNoPluginApplicationOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
CreateSwaNoPluginApplicationOptions	swaNoPluginApplicationOptions	The application options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

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

CreateApplicationAsync(CreateSwaThreeFieldApplicationOptions, CancellationToken)

Adds a SWA 3 field application

Declaration

public Task<IApplication> CreateApplicationAsync(CreateSwaThreeFieldApplicationOptions swaThreeFieldApplicationOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
CreateSwaThreeFieldApplicationOptions	swaThreeFieldApplicationOptions	The application options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

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

CreateApplicationAsync(CreateWsFederationApplicationOptions, CancellationToken)

Adds a WS federation application

Declaration

public Task<IApplication> CreateApplicationAsync(CreateWsFederationApplicationOptions wsFederationApplicationOptions, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
CreateWsFederationApplicationOptions	wsFederationApplicationOptions	The application options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

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

CreateApplicationAsync(IApplication, Nullable<Boolean>, CancellationToken)

Adds a new application to your Okta organization.

Declaration

public Task<IApplication> CreateApplicationAsync(IApplication application, bool? activate, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
IApplication	application	The IApplication resource.
System.Nullable<System.Boolean>	activate	Executes activation lifecycle operation when creating the app
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

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

CreateApplicationGroupAssignmentAsync(CreateApplicationGroupAssignmentOptions, CancellationToken)

Assigns a group to an application

Declaration

public Task<IApplicationGroupAssignment> CreateApplicationGroupAssignmentAsync(CreateApplicationGroupAssignmentOptions options, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
CreateApplicationGroupAssignmentOptions	options	The assignment options
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<IApplicationGroupAssignment>	The IApplication response.

CreateApplicationGroupAssignmentAsync(IApplicationGroupAssignment, String, String, CancellationToken)

Assigns a group to an application

Declaration

public Task<IApplicationGroupAssignment> CreateApplicationGroupAssignmentAsync(IApplicationGroupAssignment applicationGroupAssignment, string appId, string groupId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
IApplicationGroupAssignment	applicationGroupAssignment	The IApplicationGroupAssignment resource.
System.String	appId
System.String	groupId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

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

DeactivateApplicationAsync(String, CancellationToken)

Deactivates an active application.

Declaration

public Task DeactivateApplicationAsync(string appId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task	A Task that represents the asynchronous operation.

DeleteApplicationAsync(String, CancellationToken)

Removes an inactive application.

Declaration

public Task DeleteApplicationAsync(string appId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task	A Task that represents the asynchronous operation.

DeleteApplicationGroupAssignmentAsync(String, String, CancellationToken)

Removes a group assignment from an application.

Declaration

public Task DeleteApplicationGroupAssignmentAsync(string appId, string groupId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task	A Task that represents the asynchronous operation.

DeleteApplicationUserAsync(String, String)

Removes an assignment for a user from an application.

Declaration

public Task DeleteApplicationUserAsync(string appId, string userId)

Parameters

Type	Name	Description
System.String	appId	The application ID
System.String	userId	The user ID

Returns

Type	Description
System.Threading.Tasks.Task	A Task that represents the asynchronous operation.

Remarks

Explicit overload to support backward compatibility.

DeleteApplicationUserAsync(String, String, Nullable<Boolean>, CancellationToken)

Removes an assignment for a user from an application.

Declaration

public Task DeleteApplicationUserAsync(string appId, string userId, bool? sendEmail, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	appId
System.String	userId
System.Nullable<System.Boolean>	sendEmail
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task	A Task that represents the asynchronous operation.

DeleteApplicationUserAsync(String, String, CancellationToken)

Removes an assignment for a user from an application.

Declaration

public Task DeleteApplicationUserAsync(string appId, string userId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	appId	The application ID
System.String	userId	The user ID
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task	A Task that represents the asynchronous operation.

Remarks

Explicit overload to support backward compatibility.

GenerateApplicationKeyAsync(String, Nullable<Int32>, CancellationToken)

Generates a new X.509 certificate for an application key credential

Declaration

public Task<IJsonWebKey> GenerateApplicationKeyAsync(string appId, int? validityYears = default(int? ), CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	appId
System.Nullable<System.Int32>	validityYears
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

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

GenerateCsrForApplicationAsync(ICsrMetadata, String, CancellationToken)

Generates a new key pair and returns the Certificate Signing Request for it.

Declaration

public Task<ICsr> GenerateCsrForApplicationAsync(ICsrMetadata metadata, string appId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
ICsrMetadata	metadata	The ICsrMetadata resource.
System.String	appId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

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

GetApplicationAsync(String, String, CancellationToken)

Fetches an application from your Okta organization by id.

Declaration

public Task<IApplication> GetApplicationAsync(string appId, string expand = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

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

GetApplicationAsync<T>(String, CancellationToken)

Gets an application by id

Declaration

public Task<T> GetApplicationAsync<T>(string appId, CancellationToken cancellationToken = default(CancellationToken))
    where T : class, IApplication

Parameters

Type	Name	Description
System.String	appId	The application id
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<T>	The IApplication response.

Type Parameters

Name	Description
T	The application type

GetApplicationGroupAssignmentAsync(String, String, String, CancellationToken)

Fetches an application group assignment

Declaration

public Task<IApplicationGroupAssignment> GetApplicationGroupAssignmentAsync(string appId, string groupId, string expand = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	appId
System.String	groupId
System.String	expand
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

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

GetApplicationKeyAsync(String, String, CancellationToken)

Gets a specific application key credential by kid

Declaration

public Task<IJsonWebKey> GetApplicationKeyAsync(string appId, string keyId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

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

GetApplicationUserAsync(String, String, String, CancellationToken)

Fetches a specific user assignment for application by id.

Declaration

public Task<IAppUser> GetApplicationUserAsync(string appId, string userId, string expand = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	appId
System.String	userId
System.String	expand
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

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

GetAsyncEnumerator(CancellationToken)

Declaration

public IAsyncEnumerator<IApplication> GetAsyncEnumerator(CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Collections.Generic.IAsyncEnumerator<IApplication>

GetCsrForApplicationAsync(String, String, CancellationToken)

Declaration

public Task<ICsr> GetCsrForApplicationAsync(string appId, string csrId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

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

GetOAuth2TokenForApplicationAsync(String, String, String, CancellationToken)

Gets a token for the specified application

Declaration

public Task<IOAuth2Token> GetOAuth2TokenForApplicationAsync(string appId, string tokenId, string expand = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	appId
System.String	tokenId
System.String	expand
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

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

GetScopeConsentGrantAsync(String, String, String, CancellationToken)

Fetches a single scope consent grant for the application

Declaration

public Task<IOAuth2ScopeConsentGrant> GetScopeConsentGrantAsync(string appId, string grantId, string expand = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	appId
System.String	grantId
System.String	expand
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

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

GrantConsentToScopeAsync(IOAuth2ScopeConsentGrant, String, CancellationToken)

Grants consent for the application to request an OAuth 2.0 Okta scope

Declaration

public Task<IOAuth2ScopeConsentGrant> GrantConsentToScopeAsync(IOAuth2ScopeConsentGrant oAuth2ScopeConsentGrant, string appId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
IOAuth2ScopeConsentGrant	oAuth2ScopeConsentGrant	The IOAuth2ScopeConsentGrant resource.
System.String	appId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

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

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

Enumerates group assignments for an application.

Declaration

public ICollectionClient<IApplicationGroupAssignment> ListApplicationGroupAssignments(string appId, string q = null, string after = null, int? limit, string expand = null)

Parameters

Type	Name	Description
System.String	appId
System.String	q
System.String	after	Specifies the pagination cursor for the next page of assignments
System.Nullable<System.Int32>	limit	Specifies the number of results for a page
System.String	expand

Returns

Type	Description
ICollectionClient<IApplicationGroupAssignment>	A collection of IApplicationGroupAssignment that can be enumerated asynchronously.

ListApplicationKeys(String)

Enumerates key credentials for an application

Declaration

public ICollectionClient<IJsonWebKey> ListApplicationKeys(string appId)

Parameters

Type	Name	Description
System.String	appId

Returns

Type	Description
ICollectionClient<IJsonWebKey>	A collection of IJsonWebKey that can be enumerated asynchronously.

ListApplications(String, String, Nullable<Int32>, String, String, Nullable<Boolean>)

Enumerates apps added to your organization with pagination. A subset of apps can be returned that match a supported filter expression or query.

Declaration

public ICollectionClient<IApplication> ListApplications(string q = null, string after = null, int? limit, string filter = null, string expand = null, bool? includeNonDeleted)

Parameters

Type	Name	Description
System.String	q
System.String	after	Specifies the pagination cursor for the next page of apps
System.Nullable<System.Int32>	limit	Specifies the number of results for a page
System.String	filter	Filters apps by status, user.id, group.id or credentials.signing.kid expression
System.String	expand	Traverses users link relationship and optionally embeds Application User resource
System.Nullable<System.Boolean>	includeNonDeleted

Returns

Type	Description
ICollectionClient<IApplication>	A collection of IApplication that can be enumerated asynchronously.

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

Enumerates all assigned application users for an application.

Declaration

public ICollectionClient<IAppUser> ListApplicationUsers(string appId, string q = null, string query_scope = null, string after = null, int? limit, string filter = null, string expand = null)

Parameters

Type	Name	Description
System.String	appId
System.String	q
System.String	query_scope
System.String	after	specifies the pagination cursor for the next page of assignments
System.Nullable<System.Int32>	limit	specifies the number of results for a page
System.String	filter
System.String	expand

Returns

Type	Description
ICollectionClient<IAppUser>	A collection of IAppUser that can be enumerated asynchronously.

ListCsrsForApplication(String)

Enumerates Certificate Signing Requests for an application

Declaration

public ICollectionClient<ICsr> ListCsrsForApplication(string appId)

Parameters

Type	Name	Description
System.String	appId

Returns

Type	Description
ICollectionClient<ICsr>	A collection of ICsr that can be enumerated asynchronously.

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

Lists all tokens for the application

Declaration

public ICollectionClient<IOAuth2Token> ListOAuth2TokensForApplication(string appId, string expand = null, string after = null, int? limit)

Parameters

Type	Name	Description
System.String	appId
System.String	expand
System.String	after
System.Nullable<System.Int32>	limit

Returns

Type	Description
ICollectionClient<IOAuth2Token>	A collection of IOAuth2Token that can be enumerated asynchronously.

ListScopeConsentGrants(String, String)

Lists all scope consent grants for the application

Declaration

public ICollectionClient<IOAuth2ScopeConsentGrant> ListScopeConsentGrants(string appId, string expand = null)

Parameters

Type	Name	Description
System.String	appId
System.String	expand

Returns

Type	Description
ICollectionClient<IOAuth2ScopeConsentGrant>	A collection of IOAuth2ScopeConsentGrant that can be enumerated asynchronously.

PublishBinaryCerCertAsync(Byte[], String, String, CancellationToken)

Publishes with an X.509 certificate in binary CER.

Declaration

public Task<IJsonWebKey> PublishBinaryCerCertAsync(byte[] certificate, string appId, string csrId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.Byte[]	certificate	The resource.
System.String	appId
System.String	csrId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

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

PublishBinaryDerCertAsync(Byte[], String, String, CancellationToken)

Publishes with an X.509 certificate a binary DER.

Declaration

public Task<IJsonWebKey> PublishBinaryDerCertAsync(byte[] certificate, string appId, string csrId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.Byte[]	certificate	The resource.
System.String	appId
System.String	csrId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

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

PublishBinaryPemCertAsync(Byte[], String, String, CancellationToken)

Publishes with an X.509 certificate in PEM format.

Declaration

public Task<IJsonWebKey> PublishBinaryPemCertAsync(byte[] certificate, string appId, string csrId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.Byte[]	certificate	The resource.
System.String	appId
System.String	csrId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

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

PublishCerCertAsync(String, String, String, CancellationToken)

Publishes with an X.509 certificate in base64 encoded CER.

Declaration

public Task<IJsonWebKey> PublishCerCertAsync(string base64EncodedCertificateData, string appId, string csrId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	base64EncodedCertificateData	The System.String resource.
System.String	appId
System.String	csrId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

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

PublishDerCertAsync(String, String, String, CancellationToken)

Publishes with an X.509 certificate in base64 encoded DER.

Declaration

public Task<IJsonWebKey> PublishDerCertAsync(string base64EncodedCertificateData, string appId, string csrId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	base64EncodedCertificateData	The System.String resource.
System.String	appId
System.String	csrId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

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

RevokeCsrFromApplicationAsync(String, String, CancellationToken)

Declaration

public Task RevokeCsrFromApplicationAsync(string appId, string csrId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task	A Task that represents the asynchronous operation.

RevokeOAuth2TokenForApplicationAsync(String, String, CancellationToken)

Revokes the specified token for the specified application

Declaration

public Task RevokeOAuth2TokenForApplicationAsync(string appId, string tokenId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task	A Task that represents the asynchronous operation.

RevokeOAuth2TokensForApplicationAsync(String, CancellationToken)

Revokes all tokens for the specified application

Declaration

public Task RevokeOAuth2TokensForApplicationAsync(string appId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task	A Task that represents the asynchronous operation.

RevokeScopeConsentGrantAsync(String, String, CancellationToken)

Revokes permission for the application to request the given scope

Declaration

public Task RevokeScopeConsentGrantAsync(string appId, string grantId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task	A Task that represents the asynchronous operation.

UpdateApplicationAsync(IApplication, String, CancellationToken)

Updates an application in your organization.

Declaration

public Task<IApplication> UpdateApplicationAsync(IApplication application, string appId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
IApplication	application	The IApplication resource.
System.String	appId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

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

UpdateApplicationAsync<T>(IApplication, String, CancellationToken)

Updates an application

Declaration

public Task<T> UpdateApplicationAsync<T>(IApplication application, string appId, CancellationToken cancellationToken = default(CancellationToken))
    where T : class, IApplication

Parameters

Type	Name	Description
IApplication	application	The application to update
System.String	appId	The application id
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<T>	The IApplication response.

Type Parameters

Name	Description
T	The application type

UpdateApplicationUserAsync(IAppUser, String, String, CancellationToken)

Updates a user's profile for an application

Declaration

public Task<IAppUser> UpdateApplicationUserAsync(IAppUser appUser, string appId, string userId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
IAppUser	appUser	The IAppUser resource.
System.String	appId
System.String	userId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

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

Implements

IOktaClient

IApplicationsClient

System.Collections.Generic.IAsyncEnumerable<T>