Interface IPolicy

Represents a Policy 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 IPolicy : IResource

Properties

Conditions

Declaration

IPolicyRuleConditions Conditions { get; set; }

Property Value

Type	Description
IPolicyRuleConditions

Created

Declaration

DateTimeOffset? Created { get; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>

Description

Declaration

string Description { get; set; }

Property Value

Type	Description
System.String

Id

Declaration

string Id { get; }

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

Priority

Declaration

int? Priority { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Status

Declaration

string Status { get; set; }

Property Value

Type	Description
System.String

System

Declaration

bool? System { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Type

Declaration

PolicyType Type { get; set; }

Property Value

Type	Description
PolicyType

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

CreateRuleAsync(IPolicyRule, CancellationToken)

Declaration

Task<IPolicyRule> CreateRuleAsync(IPolicyRule policyRule, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
IPolicyRule	policyRule
System.Threading.CancellationToken	cancellationToken

Returns

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

CreateRuleAsync<T>(PolicyRule, CancellationToken)

Creates a policy rule

Declaration

Task<T> CreateRuleAsync<T>(PolicyRule policyRule, CancellationToken cancellationToken = default(CancellationToken))
    where T : class, IPolicyRule

Parameters

Type	Name	Description
PolicyRule	policyRule	The policy rule
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<T>	The created policy rule

Type Parameters

Name	Description
T	The type of policy rule

DeactivateAsync(CancellationToken)

Declaration

Task DeactivateAsync(CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task

GetPolicyRuleAsync(String, CancellationToken)

Declaration

Task<IPolicyRule> GetPolicyRuleAsync(string ruleId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

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

GetPolicyRuleAsync<T>(String, CancellationToken)

Gets a policy rule

Declaration

Task<T> GetPolicyRuleAsync<T>(string ruleId, CancellationToken cancellationToken = default(CancellationToken))
    where T : class, IPolicyRule

Parameters

Type	Name	Description
System.String	ruleId	The policy rule Id
System.Threading.CancellationToken	cancellationToken	The cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<T>	The policy rule

Type Parameters

Name	Description
T	The type of policy rule

ListPolicyRules()

Declaration

ICollectionClient<IPolicyRule> ListPolicyRules()

Returns

Type	Description
ICollectionClient<IPolicyRule>