Package com.atlan.api

Class SSOEndpoint

java.lang.Object

com.atlan.api.AbstractEndpoint

com.atlan.api.HeraclesEndpoint

com.atlan.api.SSOEndpoint

public class SSOEndpoint
extends HeraclesEndpoint

API endpoints for operating on Atlan's SSO configuration.

Nested Class Summary

Nested classes/interfaces inherited from class com.atlan.api.AbstractEndpoint

AbstractEndpoint.RawResponse

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GROUP_MAPPER_ATTRIBUTE
static final String	GROUP_MAPPER_SYNC_MODE
static final String	IDP_GROUP_MAPPER

Fields inherited from class com.atlan.api.AbstractEndpoint

client

Constructor Summary

Constructors

Constructor	Description
SSOEndpoint(AtlanClient client)

Method Summary

Modifier and Type	Method	Description
SSOMapping	createGroupMapping(String ssoAlias, AtlanGroup group, String ssoGroupName)	Creates a new Atlan SSO group mapping.
SSOMapping	createGroupMapping(String ssoAlias, AtlanGroup group, String ssoGroupName, RequestOptions options)	Creates a new Atlan SSO group mapping.
void	deleteGroupMapping(String ssoAlias, String groupMapId)	Delete an existing Atlan SSO group mapping.
void	deleteGroupMapping(String ssoAlias, String groupMapId, RequestOptions options)	Delete an existing Atlan SSO group mapping.
SSOMapping	getGroupMapping(String ssoAlias, String groupMapId)	Retrieves an existing Atlan SSO group mapping.
SSOMapping	getGroupMapping(String ssoAlias, String groupMapId, RequestOptions options)	Retrieves an existing Atlan SSO group mapping.
List<SSOMapping>	listGroupMappings(String ssoAlias)	Retrieves all existing Atlan SSO group mappings.
List<SSOMapping>	listGroupMappings(String ssoAlias, RequestOptions options)	Retrieves all existing Atlan SSO group mappings.
SSOMapping	updateGroupMapping(String ssoAlias, AtlanGroup group, String groupMapId, String ssoGroupName)	Updates an existing Atlan SSO group mapping.
SSOMapping	updateGroupMapping(String ssoAlias, AtlanGroup group, String groupMapId, String ssoGroupName, RequestOptions options)	Updates an existing Atlan SSO group mapping.

Methods inherited from class com.atlan.api.HeraclesEndpoint

getBaseUrl

Methods inherited from class com.atlan.api.AbstractEndpoint

getBaseUrl

Methods inherited from class java.lang.Object

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

Field Details

GROUP_MAPPER_ATTRIBUTE

public static final String GROUP_MAPPER_ATTRIBUTE

See Also:

• Constant Field Values

GROUP_MAPPER_SYNC_MODE

public static final String GROUP_MAPPER_SYNC_MODE

See Also:

• Constant Field Values

IDP_GROUP_MAPPER

public static final String IDP_GROUP_MAPPER

See Also:

• Constant Field Values

Constructor Details

SSOEndpoint

public SSOEndpoint(AtlanClient client)

Method Details

listGroupMappings

public List<SSOMapping> listGroupMappings(String ssoAlias)
                                   throws AtlanException

Retrieves all existing Atlan SSO group mappings.

Parameters:

ssoAlias - name of the SSO provider

Returns:

list of existing SSO group mappings

Throws:

AtlanException - on any API communication issue

listGroupMappings

public List<SSOMapping> listGroupMappings(String ssoAlias,
 RequestOptions options)
                                   throws AtlanException

Retrieves all existing Atlan SSO group mappings.

Parameters:

ssoAlias - name of the SSO provider

options - to override default client settings

Returns:

list of existing SSO group mappings

Throws:

AtlanException - on any API communication issue

getGroupMapping

public SSOMapping getGroupMapping(String ssoAlias,
 String groupMapId)
                           throws AtlanException

Retrieves an existing Atlan SSO group mapping.

Parameters:

ssoAlias - name of the SSO provider

groupMapId - existing SSO group mapping identifier

Returns:

existing SSO group mapping

Throws:

AtlanException - on any API communication issue

getGroupMapping

public SSOMapping getGroupMapping(String ssoAlias,
 String groupMapId,
 RequestOptions options)
                           throws AtlanException

Retrieves an existing Atlan SSO group mapping.

Parameters:

ssoAlias - name of the SSO provider

groupMapId - existing SSO group mapping identifier

options - to override default client settings

Returns:

existing SSO group mapping

Throws:

AtlanException - on any API communication issue

createGroupMapping

public SSOMapping createGroupMapping(String ssoAlias,
 AtlanGroup group,
 String ssoGroupName)
                              throws AtlanException

Creates a new Atlan SSO group mapping.

Parameters:

ssoAlias - name of the SSO provider

group - existing Atlan group

ssoGroupName - name of the SSO group

Returns:

created SSO group mapping

Throws:

AtlanException - on any API communication issue

createGroupMapping

public SSOMapping createGroupMapping(String ssoAlias,
 AtlanGroup group,
 String ssoGroupName,
 RequestOptions options)
                              throws AtlanException

Creates a new Atlan SSO group mapping.

Parameters:

ssoAlias - name of the SSO provider

group - existing Atlan group

ssoGroupName - name of the SSO group

options - to override default client settings

Returns:

created SSO group mapping

Throws:

AtlanException - on any API communication issue

updateGroupMapping

public SSOMapping updateGroupMapping(String ssoAlias,
 AtlanGroup group,
 String groupMapId,
 String ssoGroupName)
                              throws AtlanException

Updates an existing Atlan SSO group mapping.

Parameters:

ssoAlias - name of the SSO provider

group - existing Atlan group

groupMapId - existing SSO group mapping identifier

ssoGroupName - name of the SSO group

Returns:

created SSO group mapping

Throws:

AtlanException - on any API communication issue

updateGroupMapping

public SSOMapping updateGroupMapping(String ssoAlias,
 AtlanGroup group,
 String groupMapId,
 String ssoGroupName,
 RequestOptions options)
                              throws AtlanException

Updates an existing Atlan SSO group mapping.

Parameters:

ssoAlias - name of the SSO provider

group - existing Atlan group

groupMapId - existing SSO group mapping identifier

ssoGroupName - name of the SSO group

options - to override default client settings

Returns:

created SSO group mapping

Throws:

AtlanException - on any API communication issue

deleteGroupMapping

public void deleteGroupMapping(String ssoAlias,
 String groupMapId)
                        throws AtlanException

Delete an existing Atlan SSO group mapping.

Parameters:

ssoAlias - name of the SSO provider

groupMapId - existing SSO group mapping identifier

Throws:

AtlanException - on any API communication issue

deleteGroupMapping

public void deleteGroupMapping(String ssoAlias,
 String groupMapId,
 RequestOptions options)
                        throws AtlanException

Delete an existing Atlan SSO group mapping.

Parameters:

ssoAlias - name of the SSO provider

groupMapId - existing SSO group mapping identifier

options - to override default client settings

Throws:

AtlanException - on any API communication issue