Interface IAuthorizationServersClient
A client that works with Okta AuthorizationServer resources.
Namespace: Okta.Sdk
Assembly: Okta.Sdk.dll
Syntax
public interface IAuthorizationServersClientMethods
ActivateAuthorizationServerAsync(String, CancellationToken)
Success
Declaration
Task ActivateAuthorizationServerAsync(string authServerId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | authServerId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A Task that represents the asynchronous operation. |
ActivateAuthorizationServerPolicyAsync(String, String, CancellationToken)
Activate Authorization Server Policy
Declaration
Task ActivateAuthorizationServerPolicyAsync(string authServerId, string policyId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | authServerId | |
| System.String | policyId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A Task that represents the asynchronous operation. |
ActivateAuthorizationServerPolicyRuleAsync(String, String, String, CancellationToken)
Activate Authorization Server Policy Rule
Declaration
Task ActivateAuthorizationServerPolicyRuleAsync(string authServerId, string policyId, string ruleId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | authServerId | |
| System.String | policyId | |
| System.String | ruleId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A Task that represents the asynchronous operation. |
CreateAuthorizationServerAsync(IAuthorizationServer, CancellationToken)
Success
Declaration
Task<IAuthorizationServer> CreateAuthorizationServerAsync(IAuthorizationServer authorizationServer, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| IAuthorizationServer | authorizationServer | The IAuthorizationServer resource. |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IAuthorizationServer> | The IAuthorizationServer response. |
CreateAuthorizationServerPolicyAsync(IAuthorizationServerPolicy, String, CancellationToken)
Success
Declaration
Task<IAuthorizationServerPolicy> CreateAuthorizationServerPolicyAsync(IAuthorizationServerPolicy policy, string authServerId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| IAuthorizationServerPolicy | policy | The IAuthorizationServerPolicy resource. |
| System.String | authServerId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IAuthorizationServerPolicy> | The IAuthorizationServerPolicy response. |
CreateAuthorizationServerPolicyRuleAsync(IAuthorizationServerPolicyRule, String, String, CancellationToken)
Creates a policy rule for the specified Custom Authorization Server and Policy.
Declaration
Task<IAuthorizationServerPolicyRule> CreateAuthorizationServerPolicyRuleAsync(IAuthorizationServerPolicyRule policyRule, string policyId, string authServerId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| IAuthorizationServerPolicyRule | policyRule | The IAuthorizationServerPolicyRule resource. |
| System.String | policyId | |
| System.String | authServerId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IAuthorizationServerPolicyRule> | The IAuthorizationServerPolicyRule response. |
CreateOAuth2ClaimAsync(IOAuth2Claim, String, CancellationToken)
Success
Declaration
Task<IOAuth2Claim> CreateOAuth2ClaimAsync(IOAuth2Claim oAuth2Claim, string authServerId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| IOAuth2Claim | oAuth2Claim | The IOAuth2Claim resource. |
| System.String | authServerId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IOAuth2Claim> | The IOAuth2Claim response. |
CreateOAuth2ScopeAsync(IOAuth2Scope, String, CancellationToken)
Success
Declaration
Task<IOAuth2Scope> CreateOAuth2ScopeAsync(IOAuth2Scope oAuth2Scope, string authServerId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| IOAuth2Scope | oAuth2Scope | The IOAuth2Scope resource. |
| System.String | authServerId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IOAuth2Scope> | The IOAuth2Scope response. |
DeactivateAuthorizationServerAsync(String, CancellationToken)
Success
Declaration
Task DeactivateAuthorizationServerAsync(string authServerId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | authServerId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A Task that represents the asynchronous operation. |
DeactivateAuthorizationServerPolicyAsync(String, String, CancellationToken)
Deactivate Authorization Server Policy
Declaration
Task DeactivateAuthorizationServerPolicyAsync(string authServerId, string policyId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | authServerId | |
| System.String | policyId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A Task that represents the asynchronous operation. |
DeactivateAuthorizationServerPolicyRuleAsync(String, String, String, CancellationToken)
Deactivate Authorization Server Policy Rule
Declaration
Task DeactivateAuthorizationServerPolicyRuleAsync(string authServerId, string policyId, string ruleId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | authServerId | |
| System.String | policyId | |
| System.String | ruleId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A Task that represents the asynchronous operation. |
DeleteAuthorizationServerAsync(String, CancellationToken)
Success
Declaration
Task DeleteAuthorizationServerAsync(string authServerId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | authServerId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A Task that represents the asynchronous operation. |
DeleteAuthorizationServerPolicyAsync(String, String, CancellationToken)
Success
Declaration
Task DeleteAuthorizationServerPolicyAsync(string authServerId, string policyId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | authServerId | |
| System.String | policyId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A Task that represents the asynchronous operation. |
DeleteAuthorizationServerPolicyRuleAsync(String, String, String, CancellationToken)
Deletes a Policy Rule defined in the specified Custom Authorization Server and Policy.
Declaration
Task DeleteAuthorizationServerPolicyRuleAsync(string policyId, string authServerId, string ruleId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | policyId | |
| System.String | authServerId | |
| System.String | ruleId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A Task that represents the asynchronous operation. |
DeleteOAuth2ClaimAsync(String, String, CancellationToken)
Success
Declaration
Task DeleteOAuth2ClaimAsync(string authServerId, string claimId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | authServerId | |
| System.String | claimId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A Task that represents the asynchronous operation. |
DeleteOAuth2ScopeAsync(String, String, CancellationToken)
Success
Declaration
Task DeleteOAuth2ScopeAsync(string authServerId, string scopeId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | authServerId | |
| System.String | scopeId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A Task that represents the asynchronous operation. |
GetAuthorizationServerAsync(String, CancellationToken)
Success
Declaration
Task<IAuthorizationServer> GetAuthorizationServerAsync(string authServerId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | authServerId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IAuthorizationServer> | The IAuthorizationServer response. |
GetAuthorizationServerPolicyAsync(String, String, CancellationToken)
Success
Declaration
Task<IAuthorizationServerPolicy> GetAuthorizationServerPolicyAsync(string authServerId, string policyId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | authServerId | |
| System.String | policyId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IAuthorizationServerPolicy> | The IAuthorizationServerPolicy response. |
GetAuthorizationServerPolicyRuleAsync(String, String, String, CancellationToken)
Returns a Policy Rule by ID that is defined in the specified Custom Authorization Server and Policy.
Declaration
Task<IAuthorizationServerPolicyRule> GetAuthorizationServerPolicyRuleAsync(string policyId, string authServerId, string ruleId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | policyId | |
| System.String | authServerId | |
| System.String | ruleId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IAuthorizationServerPolicyRule> | The IAuthorizationServerPolicyRule response. |
GetOAuth2ClaimAsync(String, String, CancellationToken)
Success
Declaration
Task<IOAuth2Claim> GetOAuth2ClaimAsync(string authServerId, string claimId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | authServerId | |
| System.String | claimId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IOAuth2Claim> | The IOAuth2Claim response. |
GetOAuth2ScopeAsync(String, String, CancellationToken)
Success
Declaration
Task<IOAuth2Scope> GetOAuth2ScopeAsync(string authServerId, string scopeId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | authServerId | |
| System.String | scopeId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IOAuth2Scope> | The IOAuth2Scope response. |
GetRefreshTokenForAuthorizationServerAndClientAsync(String, String, String, String, CancellationToken)
Success
Declaration
Task<IOAuth2RefreshToken> GetRefreshTokenForAuthorizationServerAndClientAsync(string authServerId, string clientId, string tokenId, string expand = null, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | authServerId | |
| System.String | clientId | |
| System.String | tokenId | |
| System.String | expand | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IOAuth2RefreshToken> | The IOAuth2RefreshToken response. |
ListAuthorizationServerKeys(String)
Success
Declaration
ICollectionClient<IJsonWebKey> ListAuthorizationServerKeys(string authServerId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | authServerId |
Returns
| Type | Description |
|---|---|
| ICollectionClient<IJsonWebKey> | A collection of IJsonWebKey that can be enumerated asynchronously. |
ListAuthorizationServerPolicies(String)
Success
Declaration
ICollectionClient<IAuthorizationServerPolicy> ListAuthorizationServerPolicies(string authServerId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | authServerId |
Returns
| Type | Description |
|---|---|
| ICollectionClient<IAuthorizationServerPolicy> | A collection of IAuthorizationServerPolicy that can be enumerated asynchronously. |
ListAuthorizationServerPolicyRules(String, String)
Enumerates all policy rules for the specified Custom Authorization Server and Policy.
Declaration
ICollectionClient<IAuthorizationServerPolicyRule> ListAuthorizationServerPolicyRules(string policyId, string authServerId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | policyId | |
| System.String | authServerId |
Returns
| Type | Description |
|---|---|
| ICollectionClient<IAuthorizationServerPolicyRule> | A collection of IAuthorizationServerPolicyRule that can be enumerated asynchronously. |
ListAuthorizationServers(String, String, String)
Success
Declaration
ICollectionClient<IAuthorizationServer> ListAuthorizationServers(string q = null, string limit = null, string after = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | q | |
| System.String | limit | |
| System.String | after |
Returns
| Type | Description |
|---|---|
| ICollectionClient<IAuthorizationServer> | A collection of IAuthorizationServer that can be enumerated asynchronously. |
ListOAuth2Claims(String)
Success
Declaration
ICollectionClient<IOAuth2Claim> ListOAuth2Claims(string authServerId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | authServerId |
Returns
| Type | Description |
|---|---|
| ICollectionClient<IOAuth2Claim> | A collection of IOAuth2Claim that can be enumerated asynchronously. |
ListOAuth2ClientsForAuthorizationServer(String)
Success
Declaration
ICollectionClient<IOAuth2Client> ListOAuth2ClientsForAuthorizationServer(string authServerId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | authServerId |
Returns
| Type | Description |
|---|---|
| ICollectionClient<IOAuth2Client> | A collection of IOAuth2Client that can be enumerated asynchronously. |
ListOAuth2Scopes(String, String, String, String, Nullable<Int32>)
Success
Declaration
ICollectionClient<IOAuth2Scope> ListOAuth2Scopes(string authServerId, string q = null, string filter = null, string cursor = null, int? limit)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | authServerId | |
| System.String | q | |
| System.String | filter | |
| System.String | cursor | |
| System.Nullable<System.Int32> | limit |
Returns
| Type | Description |
|---|---|
| ICollectionClient<IOAuth2Scope> | A collection of IOAuth2Scope that can be enumerated asynchronously. |
ListRefreshTokensForAuthorizationServerAndClient(String, String, String, String, Nullable<Int32>)
Success
Declaration
ICollectionClient<IOAuth2RefreshToken> ListRefreshTokensForAuthorizationServerAndClient(string authServerId, string clientId, string expand = null, string after = null, int? limit)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | authServerId | |
| System.String | clientId | |
| System.String | expand | |
| System.String | after | |
| System.Nullable<System.Int32> | limit |
Returns
| Type | Description |
|---|---|
| ICollectionClient<IOAuth2RefreshToken> | A collection of IOAuth2RefreshToken that can be enumerated asynchronously. |
RevokeRefreshTokenForAuthorizationServerAndClientAsync(String, String, String, CancellationToken)
Success
Declaration
Task RevokeRefreshTokenForAuthorizationServerAndClientAsync(string authServerId, string clientId, string tokenId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | authServerId | |
| System.String | clientId | |
| System.String | tokenId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A Task that represents the asynchronous operation. |
RevokeRefreshTokensForAuthorizationServerAndClientAsync(String, String, CancellationToken)
Success
Declaration
Task RevokeRefreshTokensForAuthorizationServerAndClientAsync(string authServerId, string clientId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | authServerId | |
| System.String | clientId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A Task that represents the asynchronous operation. |
RotateAuthorizationServerKeys(IJwkUse, String)
Success
Declaration
ICollectionClient<IJsonWebKey> RotateAuthorizationServerKeys(IJwkUse use, string authServerId)Parameters
| Type | Name | Description |
|---|---|---|
| IJwkUse | use | The IJwkUse resource. |
| System.String | authServerId |
Returns
| Type | Description |
|---|---|
| ICollectionClient<IJsonWebKey> | A collection of IJsonWebKey that can be enumerated asynchronously. |
UpdateAuthorizationServerAsync(IAuthorizationServer, String, CancellationToken)
Success
Declaration
Task<IAuthorizationServer> UpdateAuthorizationServerAsync(IAuthorizationServer authorizationServer, string authServerId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| IAuthorizationServer | authorizationServer | The IAuthorizationServer resource. |
| System.String | authServerId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IAuthorizationServer> | The IAuthorizationServer response. |
UpdateAuthorizationServerPolicyAsync(IAuthorizationServerPolicy, String, String, CancellationToken)
Success
Declaration
Task<IAuthorizationServerPolicy> UpdateAuthorizationServerPolicyAsync(IAuthorizationServerPolicy policy, string authServerId, string policyId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| IAuthorizationServerPolicy | policy | The IAuthorizationServerPolicy resource. |
| System.String | authServerId | |
| System.String | policyId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IAuthorizationServerPolicy> | The IAuthorizationServerPolicy response. |
UpdateAuthorizationServerPolicyRuleAsync(IAuthorizationServerPolicyRule, String, String, String, CancellationToken)
Updates the configuration of the Policy Rule defined in the specified Custom Authorization Server and Policy.
Declaration
Task<IAuthorizationServerPolicyRule> UpdateAuthorizationServerPolicyRuleAsync(IAuthorizationServerPolicyRule policyRule, string policyId, string authServerId, string ruleId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| IAuthorizationServerPolicyRule | policyRule | The IAuthorizationServerPolicyRule resource. |
| System.String | policyId | |
| System.String | authServerId | |
| System.String | ruleId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IAuthorizationServerPolicyRule> | The IAuthorizationServerPolicyRule response. |
UpdateOAuth2ClaimAsync(IOAuth2Claim, String, String, CancellationToken)
Success
Declaration
Task<IOAuth2Claim> UpdateOAuth2ClaimAsync(IOAuth2Claim oAuth2Claim, string authServerId, string claimId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| IOAuth2Claim | oAuth2Claim | The IOAuth2Claim resource. |
| System.String | authServerId | |
| System.String | claimId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IOAuth2Claim> | The IOAuth2Claim response. |
UpdateOAuth2ScopeAsync(IOAuth2Scope, String, String, CancellationToken)
Success
Declaration
Task<IOAuth2Scope> UpdateOAuth2ScopeAsync(IOAuth2Scope oAuth2Scope, string authServerId, string scopeId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| IOAuth2Scope | oAuth2Scope | The IOAuth2Scope resource. |
| System.String | authServerId | |
| System.String | scopeId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IOAuth2Scope> | The IOAuth2Scope response. |