Okta.Sdk.Api.UserApi

All URIs are relative to https://subdomain.okta.com

Method	HTTP request	Description
ActivateUser	POST /api/v1/users/{userId}/lifecycle/activate	Activate a User
ChangePassword	POST /api/v1/users/{userId}/credentials/change_password	Change Password
ChangeRecoveryQuestion	POST /api/v1/users/{userId}/credentials/change_recovery_question	Change Recovery Question
CreateUser	POST /api/v1/users	Create a User
DeactivateUser	POST /api/v1/users/{userId}/lifecycle/deactivate	Deactivate a User
DeleteLinkedObjectForUser	DELETE /api/v1/users/{userIdOrLogin}/linkedObjects/{relationshipName}	Delete a Linked Object
DeleteUser	DELETE /api/v1/users/{userId}	Delete a User
ExpirePassword	POST /api/v1/users/{userId}/lifecycle/expire_password	Expire Password
ExpirePasswordAndGetTemporaryPassword	POST /api/v1/users/{userId}/lifecycle/expire_password_with_temp_password	Expire Password and Set Temporary Password
ForgotPassword	POST /api/v1/users/{userId}/credentials/forgot_password	Initiate Forgot Password
ForgotPasswordSetNewPassword	POST /api/v1/users/{userId}/credentials/forgot_password_recovery_question	Reset Password with Recovery Question
GenerateResetPasswordToken	POST /api/v1/users/{userId}/lifecycle/reset_password	Generate a Reset Password Token
GetRefreshTokenForUserAndClient	GET /api/v1/users/{userId}/clients/{clientId}/tokens/{tokenId}	Retrieve a Refresh Token for a Client
GetUser	GET /api/v1/users/{userId}	Retrieve a User
GetUserGrant	GET /api/v1/users/{userId}/grants/{grantId}	Retrieve a User Grant
ListAppLinks	GET /api/v1/users/{userId}/appLinks	List all Assigned Application Links
ListGrantsForUserAndClient	GET /api/v1/users/{userId}/clients/{clientId}/grants	List all Grants for a Client
ListLinkedObjectsForUser	GET /api/v1/users/{userIdOrLogin}/linkedObjects/{relationshipName}	List the primary or all of the associated Linked Object values
ListRefreshTokensForUserAndClient	GET /api/v1/users/{userId}/clients/{clientId}/tokens	List all Refresh Tokens for a Client
ListUserBlocks	GET /api/v1/users/{userId}/blocks	List all User Blocks
ListUserClients	GET /api/v1/users/{userId}/clients	List all Clients
ListUserGrants	GET /api/v1/users/{userId}/grants	List all User Grants
ListUserGroups	GET /api/v1/users/{userId}/groups	List all Groups
ListUserIdentityProviders	GET /api/v1/users/{userId}/idps	List all Identity Providers
ListUsers	GET /api/v1/users	List all Users
ReactivateUser	POST /api/v1/users/{userId}/lifecycle/reactivate	Reactivate a User
ReplaceLinkedObjectForUser	PUT /api/v1/users/{userIdOrLogin}/linkedObjects/{primaryRelationshipName}/{primaryUserId}	Replace the Linked Object value for `primary`
ReplaceUser	PUT /api/v1/users/{userId}	Replace a User
ResetFactors	POST /api/v1/users/{userId}/lifecycle/reset_factors	Reset all Factors
RevokeGrantsForUserAndClient	DELETE /api/v1/users/{userId}/clients/{clientId}/grants	Revoke all Grants for a Client
RevokeTokenForUserAndClient	DELETE /api/v1/users/{userId}/clients/{clientId}/tokens/{tokenId}	Revoke a Token for a Client
RevokeTokensForUserAndClient	DELETE /api/v1/users/{userId}/clients/{clientId}/tokens	Revoke all Refresh Tokens for a Client
RevokeUserGrant	DELETE /api/v1/users/{userId}/grants/{grantId}	Revoke a User Grant
RevokeUserGrants	DELETE /api/v1/users/{userId}/grants	Revoke all User Grants
RevokeUserSessions	DELETE /api/v1/users/{userId}/sessions	Revoke all User Sessions
SuspendUser	POST /api/v1/users/{userId}/lifecycle/suspend	Suspend a User
UnlockUser	POST /api/v1/users/{userId}/lifecycle/unlock	Unlock a User
UnsuspendUser	POST /api/v1/users/{userId}/lifecycle/unsuspend	Unsuspend a User
UpdateUser	POST /api/v1/users/{userId}	Update a User

ActivateUser

UserActivationToken ActivateUser (string userId, bool sendEmail)

Activate a User

Activates a user. This operation can only be performed on users with a STAGED or DEPROVISIONED status. Activation of a user is an asynchronous operation. The user will have the transitioningToStatus property with a value of ACTIVE during activation to indicate that the user hasn't completed the asynchronous operation. The user will have a status of ACTIVE when the activation process is complete. > Multibrand and User activation
If you want to send a branded User Activation email, change the subdomain of your request to the custom domain that's associated with the brand. For example, change subdomain.okta.com to custom.domain.one. See Multibrand and custom domains.

> Legal disclaimer
After a user is added to the Okta directory, they receive an activation email. As part of signing up for this service, you agreed not to use Okta's service/product to spam and/or send unsolicited messages. Please refrain from adding unrelated accounts to the directory as Okta is not responsible for, and disclaims any and all liability associated with, the activation email's content. You, and you alone, bear responsibility for the emails sent to any recipients.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ActivateUserExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserApi(config);
            var userId = "userId_example";  // string | ID of an existing Okta user
            var sendEmail = true;  // bool | Sends an activation email to the user if true (default to true)

            try
            {
                // Activate a User
                UserActivationToken result = apiInstance.ActivateUser(userId, sendEmail);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling UserApi.ActivateUser: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
userId	string	ID of an existing Okta user
sendEmail	bool	Sends an activation email to the user if true	[default to true]

Return type

UserActivationToken

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ChangePassword

UserCredentials ChangePassword (string userId, ChangePasswordRequest changePasswordRequest, bool? strict = null)

Change Password

Changes a user's password by validating the user's current password. This operation can only be performed on users in STAGED, ACTIVE, PASSWORD_EXPIRED, or RECOVERY status that have a valid password credential

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ChangePasswordExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserApi(config);
            var userId = "userId_example";  // string | ID of an existing Okta user
            var changePasswordRequest = new ChangePasswordRequest(); // ChangePasswordRequest | 
            var strict = true;  // bool? |  (optional) 

            try
            {
                // Change Password
                UserCredentials result = apiInstance.ChangePassword(userId, changePasswordRequest, strict);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling UserApi.ChangePassword: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
userId	string	ID of an existing Okta user
changePasswordRequest	ChangePasswordRequest
strict	bool?		[optional]

Return type

UserCredentials

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ChangeRecoveryQuestion

UserCredentials ChangeRecoveryQuestion (string userId, UserCredentials userCredentials)

Change Recovery Question

Changes a user's recovery question & answer credential by validating the user's current password. This operation can only be performed on users in STAGED, ACTIVE or RECOVERY status that have a valid password credential

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ChangeRecoveryQuestionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserApi(config);
            var userId = "userId_example";  // string | ID of an existing Okta user
            var userCredentials = new UserCredentials(); // UserCredentials | 

            try
            {
                // Change Recovery Question
                UserCredentials result = apiInstance.ChangeRecoveryQuestion(userId, userCredentials);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling UserApi.ChangeRecoveryQuestion: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
userId	string	ID of an existing Okta user
userCredentials	UserCredentials

Return type

UserCredentials

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateUser

User CreateUser (CreateUserRequest body, bool? activate = null, bool? provider = null, UserNextLogin? nextLogin = null)

Create a User

Creates a new user in your Okta organization with or without credentials
> Legal Disclaimer
After a user is added to the Okta directory, they receive an activation email. As part of signing up for this service, you agreed not to use Okta's service/product to spam and/or send unsolicited messages. Please refrain from adding unrelated accounts to the directory as Okta is not responsible for, and disclaims any and all liability associated with, the activation email's content. You, and you alone, bear responsibility for the emails sent to any recipients.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class CreateUserExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserApi(config);
            var body = new CreateUserRequest(); // CreateUserRequest | 
            var activate = true;  // bool? | Executes activation lifecycle operation when creating the user (optional)  (default to true)
            var provider = false;  // bool? | Indicates whether to create a user with a specified authentication provider (optional)  (default to false)
            var nextLogin = (UserNextLogin) "changePassword";  // UserNextLogin? | With activate=true, set nextLogin to \"changePassword\" to have the password be EXPIRED, so user must change it the next time they log in. (optional) 

            try
            {
                // Create a User
                User result = apiInstance.CreateUser(body, activate, provider, nextLogin);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling UserApi.CreateUser: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	CreateUserRequest
activate	bool?	Executes activation lifecycle operation when creating the user	[optional] [default to true]
provider	bool?	Indicates whether to create a user with a specified authentication provider	[optional] [default to false]
nextLogin	UserNextLogin?	With activate=true, set nextLogin to "changePassword" to have the password be EXPIRED, so user must change it the next time they log in.	[optional]

Return type

User

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeactivateUser

void DeactivateUser (string userId, bool? sendEmail = null)

Deactivate a User

Deactivates a user. This operation can only be performed on users that do not have a DEPROVISIONED status. While the asynchronous operation (triggered by HTTP header Prefer: respond-async) is proceeding the user's transitioningToStatus property is DEPROVISIONED. The user's status is DEPROVISIONED when the deactivation process is complete.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class DeactivateUserExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserApi(config);
            var userId = "userId_example";  // string | ID of an existing Okta user
            var sendEmail = false;  // bool? |  (optional)  (default to false)

            try
            {
                // Deactivate a User
                apiInstance.DeactivateUser(userId, sendEmail);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling UserApi.DeactivateUser: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
userId	string	ID of an existing Okta user
sendEmail	bool?		[optional] [default to false]

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteLinkedObjectForUser

void DeleteLinkedObjectForUser (string userIdOrLogin, string relationshipName)

Delete a Linked Object

Deletes linked objects for a user, relationshipName can be ONLY a primary relationship name

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class DeleteLinkedObjectForUserExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserApi(config);
            var userIdOrLogin = "userIdOrLogin_example";  // string | User ID or login value of the user assigned the `associated` relationship
            var relationshipName = "relationshipName_example";  // string | Name of the `primary` or `associated` relationship being queried

            try
            {
                // Delete a Linked Object
                apiInstance.DeleteLinkedObjectForUser(userIdOrLogin, relationshipName);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling UserApi.DeleteLinkedObjectForUser: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
userIdOrLogin	string	User ID or login value of the user assigned the `associated` relationship
relationshipName	string	Name of the `primary` or `associated` relationship being queried

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	No Content	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteUser

void DeleteUser (string userId, bool? sendEmail = null)

Delete a User

Deletes a user permanently. This operation can only be performed on users that have a DEPROVISIONED status. This action cannot be recovered!. Calling this on an ACTIVE user will transition the user to DEPROVISIONED.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class DeleteUserExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserApi(config);
            var userId = "userId_example";  // string | ID of an existing Okta user
            var sendEmail = false;  // bool? |  (optional)  (default to false)

            try
            {
                // Delete a User
                apiInstance.DeleteUser(userId, sendEmail);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling UserApi.DeleteUser: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
userId	string	ID of an existing Okta user
sendEmail	bool?		[optional] [default to false]

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	No Content	-
400	Bad Request	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ExpirePassword

User ExpirePassword (string userId)

Expire Password

Expires a user's password and transitions the user to the status of PASSWORD_EXPIRED so that the user is required to change their password at their next login

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ExpirePasswordExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserApi(config);
            var userId = "userId_example";  // string | ID of an existing Okta user

            try
            {
                // Expire Password
                User result = apiInstance.ExpirePassword(userId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling UserApi.ExpirePassword: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
userId	string	ID of an existing Okta user

Return type

User

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ExpirePasswordAndGetTemporaryPassword

TempPassword ExpirePasswordAndGetTemporaryPassword (string userId, bool? revokeSessions = null)

Expire Password and Set Temporary Password

Expires a user's password and transitions the user to the status of PASSWORD_EXPIRED so that the user is required to change their password at their next login, and also sets the user's password to a temporary password returned in the response

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ExpirePasswordAndGetTemporaryPasswordExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserApi(config);
            var userId = "userId_example";  // string | ID of an existing Okta user
            var revokeSessions = false;  // bool? | When set to `true` (and the session is a user session), all user sessions are revoked except the current session. (optional)  (default to false)

            try
            {
                // Expire Password and Set Temporary Password
                TempPassword result = apiInstance.ExpirePasswordAndGetTemporaryPassword(userId, revokeSessions);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling UserApi.ExpirePasswordAndGetTemporaryPassword: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
userId	string	ID of an existing Okta user
revokeSessions	bool?	When set to `true` (and the session is a user session), all user sessions are revoked except the current session.	[optional] [default to false]

Return type

TempPassword

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ForgotPassword

ForgotPasswordResponse ForgotPassword (string userId, bool? sendEmail = null)

Initiate Forgot Password

Initiates the forgot password flow. Generates a one-time token (OTT) that can be used to reset a user's password.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ForgotPasswordExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserApi(config);
            var userId = "userId_example";  // string | ID of an existing Okta user
            var sendEmail = true;  // bool? |  (optional)  (default to true)

            try
            {
                // Initiate Forgot Password
                ForgotPasswordResponse result = apiInstance.ForgotPassword(userId, sendEmail);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling UserApi.ForgotPassword: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
userId	string	ID of an existing Okta user
sendEmail	bool?		[optional] [default to true]

Return type

ForgotPasswordResponse

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Reset url	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ForgotPasswordSetNewPassword

UserCredentials ForgotPasswordSetNewPassword (string userId, UserCredentials userCredentials, bool? sendEmail = null)

Reset Password with Recovery Question

Resets the user's password to the specified password if the provided answer to the recovery question is correct

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ForgotPasswordSetNewPasswordExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserApi(config);
            var userId = "userId_example";  // string | ID of an existing Okta user
            var userCredentials = new UserCredentials(); // UserCredentials | 
            var sendEmail = true;  // bool? |  (optional)  (default to true)

            try
            {
                // Reset Password with Recovery Question
                UserCredentials result = apiInstance.ForgotPasswordSetNewPassword(userId, userCredentials, sendEmail);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling UserApi.ForgotPasswordSetNewPassword: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
userId	string	ID of an existing Okta user
userCredentials	UserCredentials
sendEmail	bool?		[optional] [default to true]

Return type

UserCredentials

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Credentials	-
400	Bad Request	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GenerateResetPasswordToken

ResetPasswordToken GenerateResetPasswordToken (string userId, bool sendEmail, bool? revokeSessions = null)

Generate a Reset Password Token

Generates a one-time token (OTT) that can be used to reset a user's password. The OTT link can be automatically emailed to the user or returned to the API caller and distributed using a custom flow.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class GenerateResetPasswordTokenExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserApi(config);
            var userId = "userId_example";  // string | ID of an existing Okta user
            var sendEmail = true;  // bool | 
            var revokeSessions = false;  // bool? | When set to `true` (and the session is a user session), all user sessions are revoked except the current session. (optional)  (default to false)

            try
            {
                // Generate a Reset Password Token
                ResetPasswordToken result = apiInstance.GenerateResetPasswordToken(userId, sendEmail, revokeSessions);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling UserApi.GenerateResetPasswordToken: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
userId	string	ID of an existing Okta user
sendEmail	bool
revokeSessions	bool?	When set to `true` (and the session is a user session), all user sessions are revoked except the current session.	[optional] [default to false]

Return type

ResetPasswordToken

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRefreshTokenForUserAndClient

OAuth2RefreshToken GetRefreshTokenForUserAndClient (string userId, string clientId, string tokenId, string expand = null, int? limit = null, string after = null)

Retrieve a Refresh Token for a Client

Retrieves a refresh token issued for the specified User and Client

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class GetRefreshTokenForUserAndClientExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserApi(config);
            var userId = "userId_example";  // string | ID of an existing Okta user
            var clientId = 52Uy4BUWVBOjFItcg2jWsmnd83Ad8dD;  // string | `client_id` of the app
            var tokenId = sHHSth53yJAyNSTQKDJZ;  // string | `id` of Token
            var expand = "expand_example";  // string |  (optional) 
            var limit = 20;  // int? |  (optional)  (default to 20)
            var after = "after_example";  // string |  (optional) 

            try
            {
                // Retrieve a Refresh Token for a Client
                OAuth2RefreshToken result = apiInstance.GetRefreshTokenForUserAndClient(userId, clientId, tokenId, expand, limit, after);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling UserApi.GetRefreshTokenForUserAndClient: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
userId	string	ID of an existing Okta user
clientId	string	`client_id` of the app
tokenId	string	`id` of Token
expand	string		[optional]
limit	int?		[optional] [default to 20]
after	string		[optional]

Return type

OAuth2RefreshToken

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUser

UserGetSingleton GetUser (string userId, string expand = null)

Retrieve a User

Retrieves a user from your Okta organization

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class GetUserExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserApi(config);
            var userId = "userId_example";  // string | ID of an existing Okta user
            var expand = blocks;  // string | An optional parameter to include metadata in the `_embedded` attribute. Valid value: `blocks` (optional) 

            try
            {
                // Retrieve a User
                UserGetSingleton result = apiInstance.GetUser(userId, expand);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling UserApi.GetUser: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
userId	string	ID of an existing Okta user
expand	string	An optional parameter to include metadata in the `_embedded` attribute. Valid value: `blocks`	[optional]

Return type

UserGetSingleton

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUserGrant

OAuth2ScopeConsentGrant GetUserGrant (string userId, string grantId, string expand = null)

Retrieve a User Grant

Retrieves a grant for the specified user

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class GetUserGrantExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserApi(config);
            var userId = "userId_example";  // string | ID of an existing Okta user
            var grantId = iJoqkwx50mrgX4T9LcaH;  // string | Grant ID
            var expand = "expand_example";  // string |  (optional) 

            try
            {
                // Retrieve a User Grant
                OAuth2ScopeConsentGrant result = apiInstance.GetUserGrant(userId, grantId, expand);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling UserApi.GetUserGrant: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
userId	string	ID of an existing Okta user
grantId	string	Grant ID
expand	string		[optional]

Return type

OAuth2ScopeConsentGrant

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListAppLinks

List<AppLink> ListAppLinks (string userId)

List all Assigned Application Links

Lists all appLinks for all direct or indirect (via group membership) assigned applications

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ListAppLinksExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserApi(config);
            var userId = "userId_example";  // string | ID of an existing Okta user

            try
            {
                // List all Assigned Application Links
                List<AppLink> result = apiInstance.ListAppLinks(userId).ToListAsync();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling UserApi.ListAppLinks: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
userId	string	ID of an existing Okta user

Return type

List<AppLink>

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListGrantsForUserAndClient

List<OAuth2ScopeConsentGrant> ListGrantsForUserAndClient (string userId, string clientId, string expand = null, string after = null, int? limit = null)

List all Grants for a Client

Lists all grants for a specified user and client

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ListGrantsForUserAndClientExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserApi(config);
            var userId = "userId_example";  // string | ID of an existing Okta user
            var clientId = 52Uy4BUWVBOjFItcg2jWsmnd83Ad8dD;  // string | `client_id` of the app
            var expand = "expand_example";  // string |  (optional) 
            var after = "after_example";  // string |  (optional) 
            var limit = 20;  // int? |  (optional)  (default to 20)

            try
            {
                // List all Grants for a Client
                List<OAuth2ScopeConsentGrant> result = apiInstance.ListGrantsForUserAndClient(userId, clientId, expand, after, limit).ToListAsync();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling UserApi.ListGrantsForUserAndClient: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
userId	string	ID of an existing Okta user
clientId	string	`client_id` of the app
expand	string		[optional]
after	string		[optional]
limit	int?		[optional] [default to 20]

Return type

List<OAuth2ScopeConsentGrant>

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListLinkedObjectsForUser

List<Object> ListLinkedObjectsForUser (string userIdOrLogin, string relationshipName, string after = null, int? limit = null)

List the primary or all of the associated Linked Object values

Lists either the self link for the primary user or all associated users in the relationship specified by relationshipName. If the specified user isn't associated in any relationship, an empty array is returned.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ListLinkedObjectsForUserExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UserApi(config);
            var userIdOrLogin = "userIdOrLogin_example";  // string | User ID or login value of the user assigned the `associated` relationship
            var relationshipName = "relationshipName_example";  // string | Name of the `primary` or `associated` relationship being queried
            var after = "after_example";  // string |  (optional) 
            var limit = -1;  // int? |  (optional)  (default to -1)

            try
            {
                // List the primary or all of the associated Linked Object values
                List<Object> result = apiInstance.ListLinkedObjectsForUser(userIdOrLogin, relationshipName, after, limit).ToListAsync();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling UserApi.ListLinkedObjectsForUser: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
userIdOrLogin	string	User ID or login value of the user assigned the `associated` relationship
relationshipName	string	Name of the `primary` or `associated` relationship being queried
after	string		[optional]
limit	int?		[optional] [default to -1]

Return type

List

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

200 Success -

403 Forbidden -

404 Not Found -

429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListRefreshTokensForUserAndClient

List<OAuth2RefreshToken> ListRefreshTokensForUserAndClient (string userId, string clientId, string expand = null, string after = null, int? limit = null)

List all Refresh Tokens for a Client

Lists all refresh tokens issued for the specified User and Client

Example

using System.Collections.Generic; using System.Diagnostics; using Okta.Sdk.Api; using Okta.Sdk.Client; using Okta.Sdk.Model; namespace Example { public class ListRefreshTokensForUserAndClientExample { public static void Main() { Configuration config = new Configuration(); config.OktaDomain = "https://subdomain.okta.com"; // Configure API key authorization: apiToken config.Token ="YOUR_API_KEY"; // Configure OAuth2 access token for authorization: oauth2 config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new UserApi(config); var userId = "userId_example"; // string | ID of an existing Okta user var clientId = 52Uy4BUWVBOjFItcg2jWsmnd83Ad8dD; // string | `client_id` of the app var expand = "expand_example"; // string | (optional) var after = "after_example"; // string | (optional) var limit = 20; // int? | (optional) (default to 20) try { // List all Refresh Tokens for a Client List<OAuth2RefreshToken> result = apiInstance.ListRefreshTokensForUserAndClient(userId, clientId, expand, after, limit).ToListAsync(); Debug.WriteLine(result); } catch (ApiException e) { Debug.Print("Exception when calling UserApi.ListRefreshTokensForUserAndClient: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

userId string ID of an existing Okta user

clientId string `client_id` of the app

expand string [optional]

after string [optional]

limit int? [optional] [default to 20]

Return type

List<OAuth2RefreshToken>

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

200 Success -

403 Forbidden -

404 Not Found -

429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListUserBlocks

List<UserBlock> ListUserBlocks (string userId)

List all User Blocks

Lists information about how the user is blocked from accessing their account

Example

using System.Collections.Generic; using System.Diagnostics; using Okta.Sdk.Api; using Okta.Sdk.Client; using Okta.Sdk.Model; namespace Example { public class ListUserBlocksExample { public static void Main() { Configuration config = new Configuration(); config.OktaDomain = "https://subdomain.okta.com"; // Configure API key authorization: apiToken config.Token ="YOUR_API_KEY"; // Configure OAuth2 access token for authorization: oauth2 config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new UserApi(config); var userId = "userId_example"; // string | ID of an existing Okta user try { // List all User Blocks List<UserBlock> result = apiInstance.ListUserBlocks(userId).ToListAsync(); Debug.WriteLine(result); } catch (ApiException e) { Debug.Print("Exception when calling UserApi.ListUserBlocks: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

userId string ID of an existing Okta user

Return type

List<UserBlock>

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

200 Success -

403 Forbidden -

404 Not Found -

429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListUserClients

List<OAuth2Client> ListUserClients (string userId)

List all Clients

Lists all client resources for which the specified user has grants or tokens

Example

using System.Collections.Generic; using System.Diagnostics; using Okta.Sdk.Api; using Okta.Sdk.Client; using Okta.Sdk.Model; namespace Example { public class ListUserClientsExample { public static void Main() { Configuration config = new Configuration(); config.OktaDomain = "https://subdomain.okta.com"; // Configure API key authorization: apiToken config.Token ="YOUR_API_KEY"; // Configure OAuth2 access token for authorization: oauth2 config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new UserApi(config); var userId = "userId_example"; // string | ID of an existing Okta user try { // List all Clients List<OAuth2Client> result = apiInstance.ListUserClients(userId).ToListAsync(); Debug.WriteLine(result); } catch (ApiException e) { Debug.Print("Exception when calling UserApi.ListUserClients: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

userId string ID of an existing Okta user

Return type

List<OAuth2Client>

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

200 Success -

403 Forbidden -

404 Not Found -

429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListUserGrants

List<OAuth2ScopeConsentGrant> ListUserGrants (string userId, string scopeId = null, string expand = null, string after = null, int? limit = null)

List all User Grants

Lists all grants for the specified user

Example

using System.Collections.Generic; using System.Diagnostics; using Okta.Sdk.Api; using Okta.Sdk.Client; using Okta.Sdk.Model; namespace Example { public class ListUserGrantsExample { public static void Main() { Configuration config = new Configuration(); config.OktaDomain = "https://subdomain.okta.com"; // Configure API key authorization: apiToken config.Token ="YOUR_API_KEY"; // Configure OAuth2 access token for authorization: oauth2 config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new UserApi(config); var userId = "userId_example"; // string | ID of an existing Okta user var scopeId = "scopeId_example"; // string | (optional) var expand = "expand_example"; // string | (optional) var after = "after_example"; // string | (optional) var limit = 20; // int? | (optional) (default to 20) try { // List all User Grants List<OAuth2ScopeConsentGrant> result = apiInstance.ListUserGrants(userId, scopeId, expand, after, limit).ToListAsync(); Debug.WriteLine(result); } catch (ApiException e) { Debug.Print("Exception when calling UserApi.ListUserGrants: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

userId string ID of an existing Okta user

scopeId string [optional]

expand string [optional]

after string [optional]

limit int? [optional] [default to 20]

Return type

List<OAuth2ScopeConsentGrant>

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

200 Success -

403 Forbidden -

404 Not Found -

429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListUserGroups

List<Group> ListUserGroups (string userId, string after = null, int? limit = null)

List all Groups

Lists all groups of which the user is a member

Example

using System.Collections.Generic; using System.Diagnostics; using Okta.Sdk.Api; using Okta.Sdk.Client; using Okta.Sdk.Model; namespace Example { public class ListUserGroupsExample { public static void Main() { Configuration config = new Configuration(); config.OktaDomain = "https://subdomain.okta.com"; // Configure API key authorization: apiToken config.Token ="YOUR_API_KEY"; // Configure OAuth2 access token for authorization: oauth2 config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new UserApi(config); var userId = "userId_example"; // string | ID of an existing Okta user var after = "after_example"; // string | The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination). (optional) var limit = 20; // int? | A limit on the number of objects to return (optional) (default to 20) try { // List all Groups List<Group> result = apiInstance.ListUserGroups(userId, after, limit).ToListAsync(); Debug.WriteLine(result); } catch (ApiException e) { Debug.Print("Exception when calling UserApi.ListUserGroups: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

userId string ID of an existing Okta user

after string The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See Pagination. [optional]

limit int? A limit on the number of objects to return [optional] [default to 20]

Return type

List<Group>

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

200 Success -

403 Forbidden -

404 Not Found -

429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListUserIdentityProviders

List<IdentityProvider> ListUserIdentityProviders (string userId)

List all Identity Providers

Lists the IdPs associated with the user

Example

using System.Collections.Generic; using System.Diagnostics; using Okta.Sdk.Api; using Okta.Sdk.Client; using Okta.Sdk.Model; namespace Example { public class ListUserIdentityProvidersExample { public static void Main() { Configuration config = new Configuration(); config.OktaDomain = "https://subdomain.okta.com"; // Configure API key authorization: apiToken config.Token ="YOUR_API_KEY"; // Configure OAuth2 access token for authorization: oauth2 config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new UserApi(config); var userId = "userId_example"; // string | ID of an existing Okta user try { // List all Identity Providers List<IdentityProvider> result = apiInstance.ListUserIdentityProviders(userId).ToListAsync(); Debug.WriteLine(result); } catch (ApiException e) { Debug.Print("Exception when calling UserApi.ListUserIdentityProviders: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

userId string ID of an existing Okta user

Return type

List<IdentityProvider>

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

200 Success -

403 Forbidden -

404 Not Found -

429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListUsers

List<User> ListUsers (string q = null, string after = null, int? limit = null, string filter = null, string search = null, string sortBy = null, string sortOrder = null)

List all Users

Lists all users that do not have a status of 'DEPROVISIONED' (by default), up to the maximum (200 for most orgs), with pagination. A subset of users can be returned that match a supported filter expression or search criteria.

Example

using System.Collections.Generic; using System.Diagnostics; using Okta.Sdk.Api; using Okta.Sdk.Client; using Okta.Sdk.Model; namespace Example { public class ListUsersExample { public static void Main() { Configuration config = new Configuration(); config.OktaDomain = "https://subdomain.okta.com"; // Configure API key authorization: apiToken config.Token ="YOUR_API_KEY"; // Configure OAuth2 access token for authorization: oauth2 config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new UserApi(config); var q = "q_example"; // string | Finds a user that matches firstName, lastName, and email properties (optional) var after = "after_example"; // string | The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination). (optional) var limit = 200; // int? | Specifies the number of results returned. Defaults to 10 if `q` is provided. (optional) (default to 200) var filter = "filter_example"; // string | Filters users with a supported expression for a subset of properties (optional) var search = "search_example"; // string | Searches for users with a supported filtering expression for most properties. Okta recommends using this parameter for search for best performance. (optional) var sortBy = "sortBy_example"; // string | (optional) var sortOrder = "sortOrder_example"; // string | Sorting is done in ASCII sort order (that is, by ASCII character value), but isn't case sensitive. (optional) try { // List all Users List<User> result = apiInstance.ListUsers(q, after, limit, filter, search, sortBy, sortOrder).ToListAsync(); Debug.WriteLine(result); } catch (ApiException e) { Debug.Print("Exception when calling UserApi.ListUsers: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

q string Finds a user that matches firstName, lastName, and email properties [optional]

after string The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See Pagination. [optional]

limit int? Specifies the number of results returned. Defaults to 10 if `q` is provided. [optional] [default to 200]

filter string Filters users with a supported expression for a subset of properties [optional]

search string Searches for users with a supported filtering expression for most properties. Okta recommends using this parameter for search for best performance. [optional]

sortBy string [optional]

sortOrder string Sorting is done in ASCII sort order (that is, by ASCII character value), but isn't case sensitive. [optional]

Return type

List<User>

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

200 Success -

403 Forbidden -

429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReactivateUser

UserActivationToken ReactivateUser (string userId, bool? sendEmail = null)

Reactivate a User

Reactivates a user. This operation can only be performed on users with a PROVISIONED status. This operation restarts the activation workflow if the user activation wasn't completed with the activationToken from Activate a user. > Note: A successful request to this endpoint records the same set of events as when a user is activated in System Logs, since it invokes the same activation workflow.

Example

using System.Collections.Generic; using System.Diagnostics; using Okta.Sdk.Api; using Okta.Sdk.Client; using Okta.Sdk.Model; namespace Example { public class ReactivateUserExample { public static void Main() { Configuration config = new Configuration(); config.OktaDomain = "https://subdomain.okta.com"; // Configure API key authorization: apiToken config.Token ="YOUR_API_KEY"; // Configure OAuth2 access token for authorization: oauth2 config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new UserApi(config); var userId = "userId_example"; // string | ID of an existing Okta user var sendEmail = false; // bool? | Sends an activation email to the user if true (optional) (default to false) try { // Reactivate a User UserActivationToken result = apiInstance.ReactivateUser(userId, sendEmail); Debug.WriteLine(result); } catch (ApiException e) { Debug.Print("Exception when calling UserApi.ReactivateUser: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

userId string ID of an existing Okta user

sendEmail bool? Sends an activation email to the user if true [optional] [default to false]

Return type

UserActivationToken

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

200 Success -

403 Forbidden -

404 Not Found -

429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReplaceLinkedObjectForUser

void ReplaceLinkedObjectForUser (string userIdOrLogin, string primaryRelationshipName, string primaryUserId)

Replace the Linked Object value for primary

Replaces the first user as the associated and the second user as the primary for the specified relationship. If the first user is already associated with a different primary for this relationship, replaces the previous link. A Linked Object relationship can specify only one primary user for an associated user.

Example

using System.Collections.Generic; using System.Diagnostics; using Okta.Sdk.Api; using Okta.Sdk.Client; using Okta.Sdk.Model; namespace Example { public class ReplaceLinkedObjectForUserExample { public static void Main() { Configuration config = new Configuration(); config.OktaDomain = "https://subdomain.okta.com"; // Configure OAuth2 access token for authorization: oauth2 config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new UserApi(config); var userIdOrLogin = "userIdOrLogin_example"; // string | User ID or login value of the user assigned the `associated` relationship var primaryRelationshipName = "primaryRelationshipName_example"; // string | Name of the `primary` relationship being assigned var primaryUserId = ctxeQ5JnAVdGFBB7Zr7W; // string | User ID to be assigned to the `primary` relationship for the `associated` user try { // Replace the Linked Object value for `primary` apiInstance.ReplaceLinkedObjectForUser(userIdOrLogin, primaryRelationshipName, primaryUserId); } catch (ApiException e) { Debug.Print("Exception when calling UserApi.ReplaceLinkedObjectForUser: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

userIdOrLogin string User ID or login value of the user assigned the `associated` relationship

primaryRelationshipName string Name of the `primary` relationship being assigned

primaryUserId string User ID to be assigned to the `primary` relationship for the `associated` user

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

204 Success -

403 Forbidden -

404 Not Found -

429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReplaceUser

User ReplaceUser (string userId, User user, bool? strict = null)

Replace a User

Replaces a user's profile and/or credentials using strict-update semantics

Example

using System.Collections.Generic; using System.Diagnostics; using Okta.Sdk.Api; using Okta.Sdk.Client; using Okta.Sdk.Model; namespace Example { public class ReplaceUserExample { public static void Main() { Configuration config = new Configuration(); config.OktaDomain = "https://subdomain.okta.com"; // Configure API key authorization: apiToken config.Token ="YOUR_API_KEY"; // Configure OAuth2 access token for authorization: oauth2 config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new UserApi(config); var userId = "userId_example"; // string | ID of an existing Okta user var user = new User(); // User | var strict = true; // bool? | (optional) try { // Replace a User User result = apiInstance.ReplaceUser(userId, user, strict); Debug.WriteLine(result); } catch (ApiException e) { Debug.Print("Exception when calling UserApi.ReplaceUser: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

userId string ID of an existing Okta user

user User

strict bool? [optional]

Return type

User

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: application/json

Accept: application/json

HTTP response details

Status code Description Response headers

200 Success -

400 Bad Request -

403 Forbidden -

404 Not Found -

429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ResetFactors

void ResetFactors (string userId, bool? removeRecoveryEnrollment = null)

Reset all Factors

Resets all factors for the specified user. All MFA factor enrollments returned to the unenrolled state. The user's status remains ACTIVE. This link is present only if the user is currently enrolled in one or more MFA factors.

Example

using System.Collections.Generic; using System.Diagnostics; using Okta.Sdk.Api; using Okta.Sdk.Client; using Okta.Sdk.Model; namespace Example { public class ResetFactorsExample { public static void Main() { Configuration config = new Configuration(); config.OktaDomain = "https://subdomain.okta.com"; // Configure API key authorization: apiToken config.Token ="YOUR_API_KEY"; // Configure OAuth2 access token for authorization: oauth2 config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new UserApi(config); var userId = "userId_example"; // string | ID of an existing Okta user var removeRecoveryEnrollment = false; // bool? | If `true`, removes the phone number as both a recovery method and a Factor. Supported Factors: `sms` and `call` (optional) (default to false) try { // Reset all Factors apiInstance.ResetFactors(userId, removeRecoveryEnrollment); } catch (ApiException e) { Debug.Print("Exception when calling UserApi.ResetFactors: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

userId string ID of an existing Okta user

removeRecoveryEnrollment bool? If `true`, removes the phone number as both a recovery method and a Factor. Supported Factors: `sms` and `call` [optional] [default to false]

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

200 OK -

403 Forbidden -

404 Not Found -

429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RevokeGrantsForUserAndClient

void RevokeGrantsForUserAndClient (string userId, string clientId)

Revoke all Grants for a Client

Revokes all grants for the specified user and client

Example

using System.Collections.Generic; using System.Diagnostics; using Okta.Sdk.Api; using Okta.Sdk.Client; using Okta.Sdk.Model; namespace Example { public class RevokeGrantsForUserAndClientExample { public static void Main() { Configuration config = new Configuration(); config.OktaDomain = "https://subdomain.okta.com"; // Configure API key authorization: apiToken config.Token ="YOUR_API_KEY"; // Configure OAuth2 access token for authorization: oauth2 config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new UserApi(config); var userId = "userId_example"; // string | ID of an existing Okta user var clientId = 52Uy4BUWVBOjFItcg2jWsmnd83Ad8dD; // string | `client_id` of the app try { // Revoke all Grants for a Client apiInstance.RevokeGrantsForUserAndClient(userId, clientId); } catch (ApiException e) { Debug.Print("Exception when calling UserApi.RevokeGrantsForUserAndClient: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

userId string ID of an existing Okta user

clientId string `client_id` of the app

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

204 No Content -

403 Forbidden -

404 Not Found -

429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RevokeTokenForUserAndClient

void RevokeTokenForUserAndClient (string userId, string clientId, string tokenId)

Revoke a Token for a Client

Revokes the specified refresh token

Example

using System.Collections.Generic; using System.Diagnostics; using Okta.Sdk.Api; using Okta.Sdk.Client; using Okta.Sdk.Model; namespace Example { public class RevokeTokenForUserAndClientExample { public static void Main() { Configuration config = new Configuration(); config.OktaDomain = "https://subdomain.okta.com"; // Configure API key authorization: apiToken config.Token ="YOUR_API_KEY"; // Configure OAuth2 access token for authorization: oauth2 config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new UserApi(config); var userId = "userId_example"; // string | ID of an existing Okta user var clientId = 52Uy4BUWVBOjFItcg2jWsmnd83Ad8dD; // string | `client_id` of the app var tokenId = sHHSth53yJAyNSTQKDJZ; // string | `id` of Token try { // Revoke a Token for a Client apiInstance.RevokeTokenForUserAndClient(userId, clientId, tokenId); } catch (ApiException e) { Debug.Print("Exception when calling UserApi.RevokeTokenForUserAndClient: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

userId string ID of an existing Okta user

clientId string `client_id` of the app

tokenId string `id` of Token

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

204 No Content -

403 Forbidden -

404 Not Found -

429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RevokeTokensForUserAndClient

void RevokeTokensForUserAndClient (string userId, string clientId)

Revoke all Refresh Tokens for a Client

Revokes all refresh tokens issued for the specified User and Client

Example

using System.Collections.Generic; using System.Diagnostics; using Okta.Sdk.Api; using Okta.Sdk.Client; using Okta.Sdk.Model; namespace Example { public class RevokeTokensForUserAndClientExample { public static void Main() { Configuration config = new Configuration(); config.OktaDomain = "https://subdomain.okta.com"; // Configure API key authorization: apiToken config.Token ="YOUR_API_KEY"; // Configure OAuth2 access token for authorization: oauth2 config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new UserApi(config); var userId = "userId_example"; // string | ID of an existing Okta user var clientId = 52Uy4BUWVBOjFItcg2jWsmnd83Ad8dD; // string | `client_id` of the app try { // Revoke all Refresh Tokens for a Client apiInstance.RevokeTokensForUserAndClient(userId, clientId); } catch (ApiException e) { Debug.Print("Exception when calling UserApi.RevokeTokensForUserAndClient: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

userId string ID of an existing Okta user

clientId string `client_id` of the app

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

204 No Content -

403 Forbidden -

404 Not Found -

429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RevokeUserGrant

void RevokeUserGrant (string userId, string grantId)

Revoke a User Grant

Revokes one grant for a specified user

Example

using System.Collections.Generic; using System.Diagnostics; using Okta.Sdk.Api; using Okta.Sdk.Client; using Okta.Sdk.Model; namespace Example { public class RevokeUserGrantExample { public static void Main() { Configuration config = new Configuration(); config.OktaDomain = "https://subdomain.okta.com"; // Configure API key authorization: apiToken config.Token ="YOUR_API_KEY"; // Configure OAuth2 access token for authorization: oauth2 config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new UserApi(config); var userId = "userId_example"; // string | ID of an existing Okta user var grantId = iJoqkwx50mrgX4T9LcaH; // string | Grant ID try { // Revoke a User Grant apiInstance.RevokeUserGrant(userId, grantId); } catch (ApiException e) { Debug.Print("Exception when calling UserApi.RevokeUserGrant: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

userId string ID of an existing Okta user

grantId string Grant ID

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

204 No Content -

403 Forbidden -

404 Not Found -

429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RevokeUserGrants

void RevokeUserGrants (string userId)

Revoke all User Grants

Revokes all grants for a specified user

Example

using System.Collections.Generic; using System.Diagnostics; using Okta.Sdk.Api; using Okta.Sdk.Client; using Okta.Sdk.Model; namespace Example { public class RevokeUserGrantsExample { public static void Main() { Configuration config = new Configuration(); config.OktaDomain = "https://subdomain.okta.com"; // Configure API key authorization: apiToken config.Token ="YOUR_API_KEY"; // Configure OAuth2 access token for authorization: oauth2 config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new UserApi(config); var userId = "userId_example"; // string | ID of an existing Okta user try { // Revoke all User Grants apiInstance.RevokeUserGrants(userId); } catch (ApiException e) { Debug.Print("Exception when calling UserApi.RevokeUserGrants: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

userId string ID of an existing Okta user

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

204 No Content -

403 Forbidden -

404 Not Found -

429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RevokeUserSessions

void RevokeUserSessions (string userId, bool? oauthTokens = null)

Revoke all User Sessions

Revokes all active identity provider sessions of the user. This forces the user to authenticate on the next operation. Optionally revokes OpenID Connect and OAuth refresh and access tokens issued to the user.

Example

using System.Collections.Generic; using System.Diagnostics; using Okta.Sdk.Api; using Okta.Sdk.Client; using Okta.Sdk.Model; namespace Example { public class RevokeUserSessionsExample { public static void Main() { Configuration config = new Configuration(); config.OktaDomain = "https://subdomain.okta.com"; // Configure API key authorization: apiToken config.Token ="YOUR_API_KEY"; // Configure OAuth2 access token for authorization: oauth2 config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new UserApi(config); var userId = "userId_example"; // string | ID of an existing Okta user var oauthTokens = false; // bool? | Revoke issued OpenID Connect and OAuth refresh and access tokens (optional) (default to false) try { // Revoke all User Sessions apiInstance.RevokeUserSessions(userId, oauthTokens); } catch (ApiException e) { Debug.Print("Exception when calling UserApi.RevokeUserSessions: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

userId string ID of an existing Okta user

oauthTokens bool? Revoke issued OpenID Connect and OAuth refresh and access tokens [optional] [default to false]

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

204 No Content -

403 Forbidden -

404 Not Found -

429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SuspendUser

void SuspendUser (string userId)

Suspend a User

Suspends a user. This operation can only be performed on users with an ACTIVE status. The user will have a status of SUSPENDED when the process is complete.

Example

using System.Collections.Generic; using System.Diagnostics; using Okta.Sdk.Api; using Okta.Sdk.Client; using Okta.Sdk.Model; namespace Example { public class SuspendUserExample { public static void Main() { Configuration config = new Configuration(); config.OktaDomain = "https://subdomain.okta.com"; // Configure API key authorization: apiToken config.Token ="YOUR_API_KEY"; // Configure OAuth2 access token for authorization: oauth2 config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new UserApi(config); var userId = "userId_example"; // string | ID of an existing Okta user try { // Suspend a User apiInstance.SuspendUser(userId); } catch (ApiException e) { Debug.Print("Exception when calling UserApi.SuspendUser: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

userId string ID of an existing Okta user

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

200 OK -

403 Forbidden -

404 Not Found -

429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UnlockUser

void UnlockUser (string userId)

Unlock a User

Unlocks a user with a LOCKED_OUT status or unlocks a user with an ACTIVE status that is blocked from unknown devices. Unlocked users have an ACTIVE status and can sign in with their current password.

Example

using System.Collections.Generic; using System.Diagnostics; using Okta.Sdk.Api; using Okta.Sdk.Client; using Okta.Sdk.Model; namespace Example { public class UnlockUserExample { public static void Main() { Configuration config = new Configuration(); config.OktaDomain = "https://subdomain.okta.com"; // Configure API key authorization: apiToken config.Token ="YOUR_API_KEY"; // Configure OAuth2 access token for authorization: oauth2 config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new UserApi(config); var userId = "userId_example"; // string | ID of an existing Okta user try { // Unlock a User apiInstance.UnlockUser(userId); } catch (ApiException e) { Debug.Print("Exception when calling UserApi.UnlockUser: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

userId string ID of an existing Okta user

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

200 Success -

403 Forbidden -

404 Not Found -

429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UnsuspendUser

void UnsuspendUser (string userId)

Unsuspend a User

Unsuspends a user and returns them to the ACTIVE state. This operation can only be performed on users that have a SUSPENDED status.

Example

using System.Collections.Generic; using System.Diagnostics; using Okta.Sdk.Api; using Okta.Sdk.Client; using Okta.Sdk.Model; namespace Example { public class UnsuspendUserExample { public static void Main() { Configuration config = new Configuration(); config.OktaDomain = "https://subdomain.okta.com"; // Configure API key authorization: apiToken config.Token ="YOUR_API_KEY"; // Configure OAuth2 access token for authorization: oauth2 config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new UserApi(config); var userId = "userId_example"; // string | ID of an existing Okta user try { // Unsuspend a User apiInstance.UnsuspendUser(userId); } catch (ApiException e) { Debug.Print("Exception when calling UserApi.UnsuspendUser: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

userId string ID of an existing Okta user

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

200 Success -

403 Forbidden -

404 Not Found -

429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateUser

User UpdateUser (string userId, UpdateUserRequest user, bool? strict = null)

Update a User

Updates a user partially determined by the request parameters

Example

using System.Collections.Generic; using System.Diagnostics; using Okta.Sdk.Api; using Okta.Sdk.Client; using Okta.Sdk.Model; namespace Example { public class UpdateUserExample { public static void Main() { Configuration config = new Configuration(); config.OktaDomain = "https://subdomain.okta.com"; // Configure API key authorization: apiToken config.Token ="YOUR_API_KEY"; // Configure OAuth2 access token for authorization: oauth2 config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new UserApi(config); var userId = "userId_example"; // string | ID of an existing Okta user var user = new UpdateUserRequest(); // UpdateUserRequest | var strict = true; // bool? | (optional) try { // Update a User User result = apiInstance.UpdateUser(userId, user, strict); Debug.WriteLine(result); } catch (ApiException e) { Debug.Print("Exception when calling UserApi.UpdateUser: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

userId string ID of an existing Okta user

user UpdateUserRequest

strict bool? [optional]

Return type

User

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: application/json

Accept: application/json

HTTP response details

Status code Description Response headers

200 Success -

400 Bad Request -

403 Forbidden -

404 Not Found -

429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Name	Type	Description	Notes
q	string	Finds a user that matches firstName, lastName, and email properties	[optional]
after	string	The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See Pagination.	[optional]
limit	int?	Specifies the number of results returned. Defaults to 10 if `q` is provided.	[optional] [default to 200]
filter	string	Filters users with a supported expression for a subset of properties	[optional]
search	string	Searches for users with a supported filtering expression for most properties. Okta recommends using this parameter for search for best performance.	[optional]
sortBy	string		[optional]
sortOrder	string	Sorting is done in ASCII sort order (that is, by ASCII character value), but isn't case sensitive.	[optional]

Files

UserApi.md

Latest commit

History

UserApi.md

File metadata and controls

Okta.Sdk.Api.UserApi

ActivateUser

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ChangePassword

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ChangeRecoveryQuestion

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

CreateUser

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeactivateUser

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeleteLinkedObjectForUser

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeleteUser

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ExpirePassword

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ExpirePasswordAndGetTemporaryPassword

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ForgotPassword

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ForgotPasswordSetNewPassword

Example

Parameters