Class Role

Represents a resource in the Okta API.

Inheritance

System.Object

Resource

Role

Implements

IRole

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 sealed class Role : Resource, IRole, IResource

Properties

AssignmentType

Declaration

public RoleAssignmentType AssignmentType { get; set; }

Property Value

Type	Description
RoleAssignmentType

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

Label

Declaration

public string Label { get; }

Property Value

Type	Description
System.String

LastUpdated

Declaration

public DateTimeOffset? LastUpdated { get; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>

Status

Declaration

public RoleStatus Status { get; }

Property Value

Type	Description
RoleStatus

Type

Declaration

public RoleType Type { get; set; }

Property Value

Type	Description
RoleType

Methods

AddAdminGroupTargetAsync(String, String, CancellationToken)

Declaration

public Task AddAdminGroupTargetAsync(string groupId, string targetGroupId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task

AddAllAppsAsTargetToRoleAsync(String, CancellationToken)

Declaration

public Task AddAllAppsAsTargetToRoleAsync(string userId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task

AddAppInstanceTargetToAdminRoleAsync(String, String, String, CancellationToken)

Declaration

public Task AddAppInstanceTargetToAdminRoleAsync(string groupId, string appName, string applicationId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	groupId
System.String	appName
System.String	applicationId
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task

AddAppTargetToAdminRoleAsync(String, String, CancellationToken)

Declaration

public Task AddAppTargetToAdminRoleAsync(string groupId, string appName, CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task

AddAppTargetToAdminRoleForUserAsync(String, String, CancellationToken)

Declaration

public Task AddAppTargetToAdminRoleForUserAsync(string userId, string appName, CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task

AddAppTargetToAppAdminRoleForUserAsync(String, String, String, CancellationToken)

Declaration

public Task AddAppTargetToAppAdminRoleForUserAsync(string userId, string appName, string applicationId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	userId
System.String	appName
System.String	applicationId
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task

Implements

IRole

IResource