Interface IGroup

Represents a Group 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 IGroup : IResource

Properties

Created

Declaration

DateTimeOffset? Created { get; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>

Id

Declaration

string Id { get; }

Property Value

Type	Description
System.String

LastMembershipUpdated

Declaration

DateTimeOffset? LastMembershipUpdated { get; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>

LastUpdated

Declaration

DateTimeOffset? LastUpdated { get; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>

ObjectClass

Declaration

IList<string> ObjectClass { get; }

Property Value

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

Profile

Declaration

IGroupProfile Profile { get; set; }

Property Value

Type	Description
IGroupProfile

Type

Declaration

GroupType Type { get; }

Property Value

Type	Description
GroupType

Users

Gets the collection of IUser in this Group.

Declaration

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

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

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

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

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

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).