Interface IRole

Represents a Role 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 IRole : IResource

Properties

AssignmentType

Declaration

RoleAssignmentType AssignmentType { get; set; }

Property Value

Type	Description
RoleAssignmentType

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

Label

Declaration

string Label { get; }

Property Value

Type	Description
System.String

LastUpdated

Declaration

DateTimeOffset? LastUpdated { get; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>

Status

Declaration

RoleStatus Status { get; }

Property Value

Type	Description
RoleStatus

Type

Declaration

RoleType Type { get; set; }

Property Value

Type	Description
RoleType

Methods

AddAdminGroupTargetAsync(String, String, CancellationToken)

Declaration

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

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

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

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

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

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