Package com.atlan.api

Class PermissionsEndpoint

java.lang.Object

com.atlan.api.AbstractEndpoint

com.atlan.api.HeraclesEndpoint

com.atlan.api.PermissionsEndpoint

public class PermissionsEndpoint
extends HeraclesEndpoint

API endpoints for retrieving evaluated permissions.

Nested Class Summary

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

AbstractEndpoint.RawResponse, AbstractEndpoint.ThrowingSupplier<T,E extends Exception>

Field Summary

Fields inherited from class com.atlan.api.AbstractEndpoint

client

Constructor Summary

Constructors

Constructor	Description
PermissionsEndpoint(AtlanClient client)

Method Summary

Modifier and Type	Method	Description
PermissionsResponse	get()	Retrieves the current authenticated user's (or client's) evaluated permissions.
PermissionsResponse	get(RequestOptions options)	Retrieves the current authenticated user's (or client's) evaluated permissions.

Methods inherited from class com.atlan.api.HeraclesEndpoint

getBaseUrl

Methods inherited from class com.atlan.api.AbstractEndpoint

executeWithRetries, getBaseUrl, getClient

Methods inherited from class java.lang.Object

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

Constructor Details

PermissionsEndpoint

public PermissionsEndpoint(AtlanClient client)

Method Details

get

public PermissionsResponse get()
                        throws AtlanException

Retrieves the current authenticated user's (or client's) evaluated permissions.

Returns:

evaluated permissions of the current context

Throws:

AtlanException - on any API communication issue

get

public PermissionsResponse get(RequestOptions options)
                        throws AtlanException

Retrieves the current authenticated user's (or client's) evaluated permissions.

Parameters:

options - to override default client settings

Returns:

evaluated permissions of the current context

Throws:

AtlanException - on any API communication issue