Class Policy

Represents a resource in the Okta API.

Inheritance

System.Object

Resource

Policy

IdentityProviderPolicy

OAuthAuthorizationPolicy

OktaSignOnPolicy

PasswordPolicy

Implements

IPolicy

IResource

Inherited Members

Resource.GetClient()

Resource.GetData()

Resource.Item[String]

Resource.GetProperty<T>(String)

Resource.SetProperty(String, Object)

Resource.GetStringProperty(String)

Resource.GetBooleanProperty(String)

Resource.GetIntegerProperty(String)

Resource.GetLongProperty(String)

Resource.GetDoubleProperty(String)

Resource.GetDateTimeProperty(String)

Resource.GetArrayProperty<T>(String)

Resource.GetEnumProperty<TEnum>(String)

Resource.GetResourceProperty<T>(String)

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 class Policy : Resource, IPolicy, IResource

Properties

Conditions

Declaration

public IPolicyRuleConditions Conditions { get; set; }

Property Value

Type	Description
IPolicyRuleConditions

Created

Declaration

public DateTimeOffset? Created { get; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>

Description

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String

Id

Declaration

public string Id { get; }

Property Value

Type	Description
System.String

LastUpdated

Declaration

public DateTimeOffset? LastUpdated { get; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>

Name

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

Priority

Declaration

public int? Priority { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Status

Declaration

public string Status { get; set; }

Property Value

Type	Description
System.String

System

Declaration

public bool? System { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Type

Declaration

public PolicyType Type { get; set; }

Property Value

Type	Description
PolicyType

Methods

ActivateAsync(CancellationToken)

Declaration

public 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

public 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

public 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

public 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

public 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

public 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

public ICollectionClient<IPolicyRule> ListPolicyRules()

Returns

Type	Description
ICollectionClient<IPolicyRule>

Implements

IPolicy

IResource