Interface IAuthorizationServer

Represents a AuthorizationServer 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 IAuthorizationServer : IResource

Properties

Audiences

Declaration

IList<string> Audiences { get; set; }

Property Value

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

Created

Declaration

DateTimeOffset? Created { get; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>

Credentials

Declaration

IAuthorizationServerCredentials Credentials { get; set; }

Property Value

Type	Description
IAuthorizationServerCredentials

Description

Declaration

string Description { get; set; }

Property Value

Type	Description
System.String

Id

Declaration

string Id { get; }

Property Value

Type	Description
System.String

Issuer

Declaration

string Issuer { get; set; }

Property Value

Type	Description
System.String

IssuerMode

Declaration

string IssuerMode { get; set; }

Property Value

Type	Description
System.String

LastUpdated

Declaration

DateTimeOffset? LastUpdated { get; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>

Name

Declaration

string Name { get; set; }

Property Value

Type	Description
System.String

Status

Declaration

string Status { get; set; }

Property Value

Type	Description
System.String

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

CreateOAuth2ClaimAsync(IOAuth2Claim, CancellationToken)

Declaration

Task<IOAuth2Claim> CreateOAuth2ClaimAsync(IOAuth2Claim oAuth2Claim, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
IOAuth2Claim	oAuth2Claim
System.Threading.CancellationToken	cancellationToken

Returns

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

CreateOAuth2ScopeAsync(IOAuth2Scope, CancellationToken)

Declaration

Task<IOAuth2Scope> CreateOAuth2ScopeAsync(IOAuth2Scope oAuth2Scope, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
IOAuth2Scope	oAuth2Scope
System.Threading.CancellationToken	cancellationToken

Returns

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

CreatePolicyAsync(IAuthorizationServerPolicy, CancellationToken)

Declaration

Task<IAuthorizationServerPolicy> CreatePolicyAsync(IAuthorizationServerPolicy policy, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
IAuthorizationServerPolicy	policy
System.Threading.CancellationToken	cancellationToken

Returns

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

DeactivateAsync(CancellationToken)

Declaration

Task DeactivateAsync(CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task

DeleteOAuth2ClaimAsync(String, CancellationToken)

Declaration

Task DeleteOAuth2ClaimAsync(string claimId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task

DeleteOAuth2ScopeAsync(String, CancellationToken)

Declaration

Task DeleteOAuth2ScopeAsync(string scopeId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task

DeletePolicyAsync(String, CancellationToken)

Declaration

Task DeletePolicyAsync(string policyId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task

GetOAuth2ClaimAsync(String, CancellationToken)

Declaration

Task<IOAuth2Claim> GetOAuth2ClaimAsync(string claimId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

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

GetOAuth2ScopeAsync(String, CancellationToken)

Declaration

Task<IOAuth2Scope> GetOAuth2ScopeAsync(string scopeId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

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

GetPolicyAsync(String, CancellationToken)

Declaration

Task<IAuthorizationServerPolicy> GetPolicyAsync(string policyId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

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

GetRefreshTokenForClientAsync(String, String, String, CancellationToken)

Declaration

Task<IOAuth2RefreshToken> GetRefreshTokenForClientAsync(string clientId, string tokenId, string expand = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

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

ListKeys()

Declaration

ICollectionClient<IJsonWebKey> ListKeys()

Returns

Type	Description
ICollectionClient<IJsonWebKey>

ListOAuth2Claims()

Declaration

ICollectionClient<IOAuth2Claim> ListOAuth2Claims()

Returns

Type	Description
ICollectionClient<IOAuth2Claim>

ListOAuth2Clients()

Declaration

ICollectionClient<IOAuth2Client> ListOAuth2Clients()

Returns

Type	Description
ICollectionClient<IOAuth2Client>

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

Declaration

ICollectionClient<IOAuth2Scope> ListOAuth2Scopes(string q = null, string filter = null, string cursor = null, int? limit)

Parameters

Type	Name	Description
System.String	q
System.String	filter
System.String	cursor
System.Nullable<System.Int32>	limit

Returns

Type	Description
ICollectionClient<IOAuth2Scope>

ListPolicies()

Declaration

ICollectionClient<IAuthorizationServerPolicy> ListPolicies()

Returns

Type	Description
ICollectionClient<IAuthorizationServerPolicy>

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

Declaration

ICollectionClient<IOAuth2RefreshToken> ListRefreshTokensForClient(string clientId, string expand = null, string after = null, int? limit)

Parameters

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

Returns

Type	Description
ICollectionClient<IOAuth2RefreshToken>

RevokeRefreshTokenForClientAsync(String, String, CancellationToken)

Declaration

Task RevokeRefreshTokenForClientAsync(string clientId, string tokenId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task

RevokeRefreshTokensForClientAsync(String, CancellationToken)

Declaration

Task RevokeRefreshTokensForClientAsync(string clientId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task

RotateKeys(IJwkUse)

Declaration

ICollectionClient<IJsonWebKey> RotateKeys(IJwkUse use)

Parameters

Type	Name	Description
IJwkUse	use

Returns

Type	Description
ICollectionClient<IJsonWebKey>

UpdateOAuth2ClaimAsync(IOAuth2Claim, String, CancellationToken)

Declaration

Task<IOAuth2Claim> UpdateOAuth2ClaimAsync(IOAuth2Claim oAuth2Claim, string claimId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
IOAuth2Claim	oAuth2Claim
System.String	claimId
System.Threading.CancellationToken	cancellationToken

Returns

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

UpdateOAuth2ScopeAsync(IOAuth2Scope, String, CancellationToken)

Declaration

Task<IOAuth2Scope> UpdateOAuth2ScopeAsync(IOAuth2Scope oAuth2Scope, string scopeId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
IOAuth2Scope	oAuth2Scope
System.String	scopeId
System.Threading.CancellationToken	cancellationToken

Returns

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

UpdatePolicyAsync(IAuthorizationServerPolicy, String, CancellationToken)

Declaration

Task<IAuthorizationServerPolicy> UpdatePolicyAsync(IAuthorizationServerPolicy policy, string policyId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
IAuthorizationServerPolicy	policy
System.String	policyId
System.Threading.CancellationToken	cancellationToken

Returns

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