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="2024-09-23T08:35:59.300824-05:00[America/Chicago]",
           comments="Generator version: 7.8.0")
public class IdentityProviderUsersApi
extends Object

Constructor Summary

Constructors

Constructor	Description
IdentityProviderUsersApi()
IdentityProviderUsersApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
IdentityProviderApplicationUser	getIdentityProviderApplicationUser(String idpId, String userId)	Retrieve a User for IdP Retrieves a linked IdP User by ID
IdentityProviderApplicationUser	getIdentityProviderApplicationUser(String idpId, String userId, Map<String,String> additionalHeaders)	Retrieve a User for IdP Retrieves a linked IdP User by ID
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
IdentityProviderApplicationUser	linkUserToIdentityProvider(String idpId, String userId, UserIdentityProviderLinkRequest userIdentityProviderLinkRequest)	Link a User to IdP Links an Okta User to an existing SAML or social Identity Provider.
IdentityProviderApplicationUser	linkUserToIdentityProvider(String idpId, String userId, UserIdentityProviderLinkRequest userIdentityProviderLinkRequest, Map<String,String> additionalHeaders)	Link a User to IdP Links an Okta User to an existing SAML or social Identity Provider.
List<IdentityProviderApplicationUser>	listIdentityProviderApplicationUsers(String idpId, String q, String after, Integer limit, String expand)	List all Users for IdP Lists all the Users linked to an Identity Provider
List<IdentityProviderApplicationUser>	listIdentityProviderApplicationUsers(String idpId, String q, String after, Integer limit, String expand, Map<String,String> additionalHeaders)	List all Users for IdP Lists all the Users linked to an Identity Provider
List<SocialAuthToken>	listSocialAuthTokens(String idpId, String userId)	List all Tokens from OIDC IdP Lists the tokens minted by the Social Authentication Provider when the user authenticates with Okta via Social Auth.
List<SocialAuthToken>	listSocialAuthTokens(String idpId, String userId, Map<String,String> additionalHeaders)	List all Tokens from OIDC IdP Lists the tokens minted by the Social Authentication Provider when the user authenticates with Okta via Social Auth.
List<IdentityProvider>	listUserIdentityProviders(String userId)	List all Identity Providers for User Lists the IdPs associated with the User
List<IdentityProvider>	listUserIdentityProviders(String userId, Map<String,String> additionalHeaders)	List all Identity Providers for User Lists the IdPs associated with the User
void	setApiClient(ApiClient apiClient)
void	unlinkUserFromIdentityProvider(String idpId, String userId)	Unlink a User from IdP Unlinks the Okta User and the IdP User.
void	unlinkUserFromIdentityProvider(String idpId, String userId, Map<String,String> additionalHeaders)	Unlink a User from IdP Unlinks the Okta User and the IdP User.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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 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 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. The SAML Identity Provider 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. The SAML Identity Provider 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

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

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

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

listUserIdentityProviders

public List<IdentityProvider> listUserIdentityProviders(String userId)
                                                 throws ApiException

List all Identity Providers for User Lists the IdPs associated with the User

Parameters:

userId - ID of an existing Okta user (required)

Returns:

List<IdentityProvider>

Throws:

ApiException - if fails to make API call

listUserIdentityProviders

public List<IdentityProvider> listUserIdentityProviders(String userId,
 Map<String,String> additionalHeaders)
                                                 throws ApiException

List all Identity Providers for User Lists the IdPs associated with the User

Parameters:

userId - ID of an existing Okta user (required)

additionalHeaders - additionalHeaders for this call

Returns:

List<IdentityProvider>

Throws:

ApiException - if fails to make API call

unlinkUserFromIdentityProvider

public void unlinkUserFromIdentityProvider(String idpId,
 String userId)
                                    throws ApiException

Unlink a User from IdP Unlinks the Okta User and the 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 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()