Interface IUserTypesClient
A client that works with Okta UserType resources.
Namespace: Okta.Sdk
Assembly: Okta.Sdk.dll
Syntax
public interface IUserTypesClientMethods
CreateUserTypeAsync(IUserType, CancellationToken)
Creates a new User Type. A default User Type is automatically created along with your org, and you may add another 9 User Types for a maximum of 10.
Declaration
Task<IUserType> CreateUserTypeAsync(IUserType userType, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| IUserType | userType | The IUserType resource. |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IUserType> | The IUserType response. |
DeleteUserTypeAsync(String, CancellationToken)
Deletes a User Type permanently. This operation is not permitted for the default type, nor for any User Type that has existing users
Declaration
Task DeleteUserTypeAsync(string typeId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | typeId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A Task that represents the asynchronous operation. |
GetUserTypeAsync(String, CancellationToken)
Fetches a User Type by ID. The special identifier default may be used to fetch the default User Type.
Declaration
Task<IUserType> GetUserTypeAsync(string typeId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | typeId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IUserType> | The IUserType response. |
ListUserTypes()
Fetches all User Types in your org
Declaration
ICollectionClient<IUserType> ListUserTypes()Returns
| Type | Description |
|---|---|
| ICollectionClient<IUserType> | A collection of IUserType that can be enumerated asynchronously. |
ReplaceUserTypeAsync(IUserType, String, CancellationToken)
Replace an existing User Type
Declaration
Task<IUserType> ReplaceUserTypeAsync(IUserType userType, string typeId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| IUserType | userType | The IUserType resource. |
| System.String | typeId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IUserType> | The IUserType response. |
UpdateUserTypeAsync(IUserType, String, CancellationToken)
Updates an existing User Type
Declaration
Task<IUserType> UpdateUserTypeAsync(IUserType userType, string typeId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| IUserType | userType | The IUserType resource. |
| System.String | typeId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IUserType> | The IUserType response. |