Package com.okta.sdk.resource.api

Class IdentityProviderUsersApi

java.lang.Object
com.okta.sdk.resource.api.IdentityProviderUsersApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2026-03-13T17:36:05.533634+05:30[Asia/Kolkata]", comments="Generator version: 7.15.0") public class IdentityProviderUsersApi extends Object

  • Constructor Details

    • IdentityProviderUsersApi

      public IdentityProviderUsersApi()

    • IdentityProviderUsersApi

      public IdentityProviderUsersApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getIdentityProviderApplicationUser

      public IdentityProviderApplicationUser getIdentityProviderApplicationUser(String idpId, String userId) throws ApiException
      Retrieve a user for IdP Retrieves a linked identity provider (IdP) user by ID
      Parameters:
      idpId - `id` of IdP (required)
      userId - ID of an existing Okta user (required)
      Returns:
      IdentityProviderApplicationUser
      Throws:
      ApiException - if fails to make API call

    • getIdentityProviderApplicationUser

      public IdentityProviderApplicationUser getIdentityProviderApplicationUser(String idpId, String userId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve a user for IdP Retrieves a linked identity provider (IdP) user by ID
      Parameters:
      idpId - `id` of IdP (required)
      userId - ID of an existing Okta user (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      IdentityProviderApplicationUser
      Throws:
      ApiException - if fails to make API call

    • linkUserToIdentityProvider

      public IdentityProviderApplicationUser linkUserToIdentityProvider(String idpId, String userId, UserIdentityProviderLinkRequest userIdentityProviderLinkRequest) throws ApiException
      Link a user to IdP Links an Okta user to an existing SAML or social identity provider (IdP). The SAML IdP must have `honorPersistentNameId` set to `true` to use this API. The [Name Identifier Format](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/replaceIdentityProvider!path=protocol/0/settings&t=request) of the incoming assertion must be `urn:oasis:names:tc:SAML:2.0:nameid-format:persistent`.
      Parameters:
      idpId - `id` of IdP (required)
      userId - ID of an existing Okta user (required)
      userIdentityProviderLinkRequest - (required)
      Returns:
      IdentityProviderApplicationUser
      Throws:
      ApiException - if fails to make API call

    • linkUserToIdentityProvider

      public IdentityProviderApplicationUser linkUserToIdentityProvider(String idpId, String userId, UserIdentityProviderLinkRequest userIdentityProviderLinkRequest, Map<String,String> additionalHeaders) throws ApiException
      Link a user to IdP Links an Okta user to an existing SAML or social identity provider (IdP). The SAML IdP must have `honorPersistentNameId` set to `true` to use this API. The [Name Identifier Format](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/replaceIdentityProvider!path=protocol/0/settings&t=request) of the incoming assertion must be `urn:oasis:names:tc:SAML:2.0:nameid-format:persistent`.
      Parameters:
      idpId - `id` of IdP (required)
      userId - ID of an existing Okta user (required)
      userIdentityProviderLinkRequest - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      IdentityProviderApplicationUser
      Throws:
      ApiException - if fails to make API call

    • listIdentityProviderApplicationUsers

      public List<IdentityProviderApplicationUser> listIdentityProviderApplicationUsers(String idpId, String q, String after, Integer limit, String expand) throws ApiException
      List all users for IdP Lists all the users linked to an identity provider (IdP)
      Parameters:
      idpId - `id` of IdP (required)
      q - Searches the records for matching value (optional)
      after - 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](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header). (optional)
      limit - A limit on the number of objects to return (optional, default to 20)
      expand - Expand user data (optional)
      Returns:
      List<IdentityProviderApplicationUser>
      Throws:
      ApiException - if fails to make API call

    • listIdentityProviderApplicationUsers

      public List<IdentityProviderApplicationUser> listIdentityProviderApplicationUsers(String idpId, String q, String after, Integer limit, String expand, Map<String,String> additionalHeaders) throws ApiException
      List all users for IdP Lists all the users linked to an identity provider (IdP)
      Parameters:
      idpId - `id` of IdP (required)
      q - Searches the records for matching value (optional)
      after - 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](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header). (optional)
      limit - A limit on the number of objects to return (optional, default to 20)
      expand - Expand user data (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<IdentityProviderApplicationUser>
      Throws:
      ApiException - if fails to make API call

    • listIdentityProviderApplicationUsersPaged

      public Iterable<IdentityProviderApplicationUser> listIdentityProviderApplicationUsersPaged(String idpId, String q, String after, Integer limit, String expand)
      List all users for IdP (Paginated) Lists all the users linked to an identity provider (IdP) This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks. Use this method in a for-each loop to automatically fetch all pages without manual cursor management.
      Parameters:
      idpId - `id` of IdP (required)
      q - Searches the records for matching value (optional)
      after - 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](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header). (optional)
      limit - A limit on the number of objects to return (optional, default to 20)
      expand - Expand user data (optional)
      Returns:
      Iterable<IdentityProviderApplicationUser> lazy iterable over all pages

    • listIdentityProviderApplicationUsersPaged

      public Iterable<IdentityProviderApplicationUser> listIdentityProviderApplicationUsersPaged(String idpId, String q, String after, Integer limit, String expand, Map<String,String> additionalHeaders)
      List all users for IdP (Paginated with additional headers) Lists all the users linked to an identity provider (IdP) This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.
      Parameters:
      idpId - `id` of IdP (required)
      q - Searches the records for matching value (optional)
      after - 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](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header). (optional)
      limit - A limit on the number of objects to return (optional, default to 20)
      expand - Expand user data (optional)
      additionalHeaders - additional headers for this call
      Returns:
      Iterable<IdentityProviderApplicationUser> lazy iterable over all pages

    • listSocialAuthTokens

      public List<SocialAuthToken> listSocialAuthTokens(String idpId, String userId) throws ApiException
      List all tokens from OIDC IdP Lists the tokens minted by the social authentication provider when the user authenticates with Okta via Social Auth. Okta doesn't import all the user information from a social provider. If the app needs information that isn't imported, it can get the user token from this endpoint. Then the app can make an API call to the social provider with the token to request the additional information.
      Parameters:
      idpId - `id` of IdP (required)
      userId - ID of an existing Okta user (required)
      Returns:
      List<SocialAuthToken>
      Throws:
      ApiException - if fails to make API call

    • listSocialAuthTokens

      public List<SocialAuthToken> listSocialAuthTokens(String idpId, String userId, Map<String,String> additionalHeaders) throws ApiException
      List all tokens from OIDC IdP Lists the tokens minted by the social authentication provider when the user authenticates with Okta via Social Auth. Okta doesn't import all the user information from a social provider. If the app needs information that isn't imported, it can get the user token from this endpoint. Then the app can make an API call to the social provider with the token to request the additional information.
      Parameters:
      idpId - `id` of IdP (required)
      userId - ID of an existing Okta user (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<SocialAuthToken>
      Throws:
      ApiException - if fails to make API call

    • listSocialAuthTokensPaged

      public Iterable<SocialAuthToken> listSocialAuthTokensPaged(String idpId, String userId)
      List all tokens from OIDC IdP (Paginated) Lists the tokens minted by the social authentication provider when the user authenticates with Okta via Social Auth. Okta doesn't import all the user information from a social provider. If the app needs information that isn't imported, it can get the user token from this endpoint. Then the app can make an API call to the social provider with the token to request the additional information. This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks. Use this method in a for-each loop to automatically fetch all pages without manual cursor management.
      Parameters:
      idpId - `id` of IdP (required)
      userId - ID of an existing Okta user (required)
      Returns:
      Iterable<SocialAuthToken> lazy iterable over all pages

    • listSocialAuthTokensPaged

      public Iterable<SocialAuthToken> listSocialAuthTokensPaged(String idpId, String userId, Map<String,String> additionalHeaders)
      List all tokens from OIDC IdP (Paginated with additional headers) Lists the tokens minted by the social authentication provider when the user authenticates with Okta via Social Auth. Okta doesn't import all the user information from a social provider. If the app needs information that isn't imported, it can get the user token from this endpoint. Then the app can make an API call to the social provider with the token to request the additional information. This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.
      Parameters:
      idpId - `id` of IdP (required)
      userId - ID of an existing Okta user (required)
      additionalHeaders - additional headers for this call
      Returns:
      Iterable<SocialAuthToken> lazy iterable over all pages

    • listUserIdentityProviders

      public List<IdentityProvider> listUserIdentityProviders(String id) throws ApiException
      List all IdPs for user Lists the identity providers (IdPs) associated with the user
      Parameters:
      id - An ID, login, or login shortname (as long as the shortname is unambiguous) of an existing Okta user (required)
      Returns:
      List<IdentityProvider>
      Throws:
      ApiException - if fails to make API call

    • listUserIdentityProviders

      public List<IdentityProvider> listUserIdentityProviders(String id, Map<String,String> additionalHeaders) throws ApiException
      List all IdPs for user Lists the identity providers (IdPs) associated with the user
      Parameters:
      id - An ID, login, or login shortname (as long as the shortname is unambiguous) of an existing Okta user (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<IdentityProvider>
      Throws:
      ApiException - if fails to make API call

    • listUserIdentityProvidersPaged

      public Iterable<IdentityProvider> listUserIdentityProvidersPaged(String id)
      List all IdPs for user (Paginated) Lists the identity providers (IdPs) associated with the user This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks. Use this method in a for-each loop to automatically fetch all pages without manual cursor management.
      Parameters:
      id - An ID, login, or login shortname (as long as the shortname is unambiguous) of an existing Okta user (required)
      Returns:
      Iterable<IdentityProvider> lazy iterable over all pages

    • listUserIdentityProvidersPaged

      public Iterable<IdentityProvider> listUserIdentityProvidersPaged(String id, Map<String,String> additionalHeaders)
      List all IdPs for user (Paginated with additional headers) Lists the identity providers (IdPs) associated with the user This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.
      Parameters:
      id - An ID, login, or login shortname (as long as the shortname is unambiguous) of an existing Okta user (required)
      additionalHeaders - additional headers for this call
      Returns:
      Iterable<IdentityProvider> lazy iterable over all pages

    • unlinkUserFromIdentityProvider

      public void unlinkUserFromIdentityProvider(String idpId, String userId) throws ApiException
      Unlink a user from IdP Unlinks the Okta user and the identity provider (IdP) user. The next time the user federates into Okta through this IdP, they have to re-link their account according to the account link policy.
      Parameters:
      idpId - `id` of IdP (required)
      userId - ID of an existing Okta user (required)
      Throws:
      ApiException - if fails to make API call

    • unlinkUserFromIdentityProvider

      public void unlinkUserFromIdentityProvider(String idpId, String userId, Map<String,String> additionalHeaders) throws ApiException
      Unlink a user from IdP Unlinks the Okta user and the identity provider (IdP) user. The next time the user federates into Okta through this IdP, they have to re-link their account according to the account link policy.
      Parameters:
      idpId - `id` of IdP (required)
      userId - ID of an existing Okta user (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getObjectMapper

      protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()