Interface IApplication

Represents a Application resource in the Okta API.

Inherited Members

IResource.Item[String]

IResource.GetArrayProperty<T>(String)

IResource.GetData()

IResource.SetProperty(String, Object)

IResource.GetProperty<T>(String)

Namespace: Okta.Sdk

Assembly: Okta.Sdk.dll

Syntax

public interface IApplication : IResource

Properties

Accessibility

Declaration

IApplicationAccessibility Accessibility { get; set; }

Property Value

Type	Description
IApplicationAccessibility

Created

Declaration

DateTimeOffset? Created { get; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>

Credentials

Declaration

IApplicationCredentials Credentials { get; set; }

Property Value

Type	Description
IApplicationCredentials

Features

Declaration

IList<string> Features { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

Id

Declaration

string Id { get; }

Property Value

Type	Description
System.String

Label

Declaration

string Label { get; set; }

Property Value

Type	Description
System.String

LastUpdated

Declaration

DateTimeOffset? LastUpdated { get; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>

Licensing

Declaration

IApplicationLicensing Licensing { get; set; }

Property Value

Type	Description
IApplicationLicensing

Name

Declaration

string Name { get; }

Property Value

Type	Description
System.String

Profile

Declaration

Resource Profile { get; set; }

Property Value

Type	Description
Resource

Settings

Declaration

IApplicationSettings Settings { get; set; }

Property Value

Type	Description
IApplicationSettings

SignOnMode

Declaration

ApplicationSignOnMode SignOnMode { get; set; }

Property Value

Type	Description
ApplicationSignOnMode

Status

Declaration

string Status { get; }

Property Value

Type	Description
System.String

Visibility

Declaration

IApplicationVisibility Visibility { get; set; }

Property Value

Type	Description
IApplicationVisibility

Methods

ActivateAsync(CancellationToken)

Declaration

Task ActivateAsync(CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task

AssignUserToApplicationAsync(IAppUser, CancellationToken)

Declaration

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

Parameters

Type	Name	Description
IAppUser	appUser
System.Threading.CancellationToken	cancellationToken

Returns

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

CloneApplicationKeyAsync(String, String, CancellationToken)

Declaration

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

Parameters

Type	Name	Description
System.String	keyId
System.String	targetAid
System.Threading.CancellationToken	cancellationToken

Returns

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

CreateApplicationGroupAssignmentAsync(IApplicationGroupAssignment, String, CancellationToken)

Declaration

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

Parameters

Type	Name	Description
IApplicationGroupAssignment	applicationGroupAssignment
System.String	groupId
System.Threading.CancellationToken	cancellationToken

Returns

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

DeactivateAsync(CancellationToken)

Declaration

Task DeactivateAsync(CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task

GenerateCsrAsync(ICsrMetadata, CancellationToken)

Declaration

Task<ICsr> GenerateCsrAsync(ICsrMetadata metadata, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
ICsrMetadata	metadata
System.Threading.CancellationToken	cancellationToken

Returns

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

GenerateKeyAsync(Nullable<Int32>, CancellationToken)

Declaration

Task<IJsonWebKey> GenerateKeyAsync(int? validityYears = default(int? ), CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.Nullable<System.Int32>	validityYears
System.Threading.CancellationToken	cancellationToken

Returns

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

GetApplicationGroupAssignmentAsync(String, String, CancellationToken)

Declaration

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

Parameters

Type	Name	Description
System.String	groupId
System.String	expand
System.Threading.CancellationToken	cancellationToken

Returns

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

GetApplicationKeyAsync(String, CancellationToken)

Declaration

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

Parameters

Type	Name	Description
System.String	keyId
System.Threading.CancellationToken	cancellationToken

Returns

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

GetApplicationUserAsync(String, String, CancellationToken)

Declaration

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

Parameters

Type	Name	Description
System.String	userId
System.String	expand
System.Threading.CancellationToken	cancellationToken

Returns

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

GetCsrAsync(String, CancellationToken)

Declaration

Task<ICsr> GetCsrAsync(string csrId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	csrId
System.Threading.CancellationToken	cancellationToken

Returns

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

GetOAuth2TokenAsync(String, String, CancellationToken)

Declaration

Task<IOAuth2Token> GetOAuth2TokenAsync(string tokenId, string expand = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	tokenId
System.String	expand
System.Threading.CancellationToken	cancellationToken

Returns

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

GetScopeConsentGrantAsync(String, String, CancellationToken)

Declaration

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

Parameters

Type	Name	Description
System.String	grantId
System.String	expand
System.Threading.CancellationToken	cancellationToken

Returns

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

GrantConsentToScopeAsync(IOAuth2ScopeConsentGrant, CancellationToken)

Declaration

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

Parameters

Type	Name	Description
IOAuth2ScopeConsentGrant	oAuth2ScopeConsentGrant
System.Threading.CancellationToken	cancellationToken

Returns

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

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

Declaration

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

Parameters

Type	Name	Description
System.String	q
System.String	query_scope
System.String	after
System.Nullable<System.Int32>	limit
System.String	filter
System.String	expand

Returns

Type	Description
ICollectionClient<IAppUser>

ListCsrs()

Declaration

ICollectionClient<ICsr> ListCsrs()

Returns

Type	Description
ICollectionClient<ICsr>

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

Declaration

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

Parameters

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

Returns

Type	Description
ICollectionClient<IApplicationGroupAssignment>

ListKeys()

Declaration

ICollectionClient<IJsonWebKey> ListKeys()

Returns

Type	Description
ICollectionClient<IJsonWebKey>

ListOAuth2Tokens(String, String, Nullable<Int32>)

Declaration

ICollectionClient<IOAuth2Token> ListOAuth2Tokens(string expand = null, string after = null, int? limit)

Parameters

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

Returns

Type	Description
ICollectionClient<IOAuth2Token>

ListScopeConsentGrants(String)

Declaration

ICollectionClient<IOAuth2ScopeConsentGrant> ListScopeConsentGrants(string expand = null)

Parameters

Type	Name	Description
System.String	expand

Returns

Type	Description
ICollectionClient<IOAuth2ScopeConsentGrant>

PublishBinaryCerCertAsync(Byte[], String, CancellationToken)

Declaration

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

Parameters

Type	Name	Description
System.Byte[]	certificate
System.String	csrId
System.Threading.CancellationToken	cancellationToken

Returns

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

PublishBinaryDerCertAsync(Byte[], String, CancellationToken)

Declaration

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

Parameters

Type	Name	Description
System.Byte[]	certificate
System.String	csrId
System.Threading.CancellationToken	cancellationToken

Returns

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

PublishBinaryPemCertAsync(Byte[], String, CancellationToken)

Declaration

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

Parameters

Type	Name	Description
System.Byte[]	certificate
System.String	csrId
System.Threading.CancellationToken	cancellationToken

Returns

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

PublishCerCertAsync(String, String, CancellationToken)

Declaration

Task<IJsonWebKey> PublishCerCertAsync(string certificate, string csrId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	certificate
System.String	csrId
System.Threading.CancellationToken	cancellationToken

Returns

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

PublishDerCertAsync(String, String, CancellationToken)

Declaration

Task<IJsonWebKey> PublishDerCertAsync(string certificate, string csrId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	certificate
System.String	csrId
System.Threading.CancellationToken	cancellationToken

Returns

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

RevokeCsrAsync(String, CancellationToken)

Declaration

Task RevokeCsrAsync(string csrId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	csrId
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task

RevokeOAuth2TokenForApplicationAsync(String, CancellationToken)

Declaration

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

Parameters

Type	Name	Description
System.String	tokenId
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task

RevokeOAuth2TokensAsync(CancellationToken)

Declaration

Task RevokeOAuth2TokensAsync(CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task

RevokeScopeConsentGrantAsync(String, CancellationToken)

Declaration

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

Parameters

Type	Name	Description
System.String	grantId
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task