Class Group

Represents a resource in the Okta API.

Inheritance

System.Object

Resource

Group

Implements

IGroup

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 Group : Resource, IGroup, IResource

Properties

Created

Declaration

public DateTimeOffset? Created { get; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>

Id

Declaration

public string Id { get; }

Property Value

Type	Description
System.String

LastMembershipUpdated

Declaration

public DateTimeOffset? LastMembershipUpdated { get; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>

LastUpdated

Declaration

public DateTimeOffset? LastUpdated { get; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>

ObjectClass

Declaration

public IList<string> ObjectClass { get; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

Profile

Declaration

public IGroupProfile Profile { get; set; }

Property Value

Type	Description
IGroupProfile

Type

Declaration

public GroupType Type { get; }

Property Value

Type	Description
GroupType

Users

Gets the collection of IUser in this Group.

Declaration

public IAsyncEnumerable<IUser> Users { get; }

Property Value

Type	Description
System.Collections.Generic.IAsyncEnumerable<IUser>	The collection of Users in this Group.

Methods

AssignRoleAsync(IAssignRoleRequest, String, CancellationToken)

Declaration

public Task<IRole> AssignRoleAsync(IAssignRoleRequest assignRoleRequest, string disableNotifications = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
IAssignRoleRequest	assignRoleRequest
System.String	disableNotifications
System.Threading.CancellationToken	cancellationToken

Returns

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

DeleteAsync(CancellationToken)

Deletes the group.

Declaration

public Task DeleteAsync(CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task	A Task that represents the asynchronous operation.

ListApplications(String, Nullable<Int32>)

Declaration

public ICollectionClient<IApplication> ListApplications(string after = null, int? limit)

Parameters

Type	Name	Description
System.String	after
System.Nullable<System.Int32>	limit

Returns

Type	Description
ICollectionClient<IApplication>

RemoveUserAsync(String, CancellationToken)

Declaration

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

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task

UpdateAsync(CancellationToken)

Saves changes and returns the updated resource.

Declaration

public Task<IGroup> UpdateAsync(CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<IGroup>	The updated IGroup.

Remarks

Alias of UpdateGroupAsync(IGroup, String, CancellationToken).

Implements

IGroup

IResource