Package com.atlan.api

Class CredentialsEndpoint

java.lang.Object

com.atlan.api.AbstractEndpoint

com.atlan.api.HeraclesEndpoint

com.atlan.api.CredentialsEndpoint

public class CredentialsEndpoint
extends HeraclesEndpoint

API endpoints for operating on Atlan's workflows.

Nested Class Summary

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

AbstractEndpoint.RawResponse

Field Summary

Fields inherited from class com.atlan.api.AbstractEndpoint

client

Constructor Summary

Constructors

Constructor	Description
CredentialsEndpoint(AtlanClient client)

Method Summary

Modifier and Type	Method	Description
CredentialResponse	get(String guid)	Retrieve a credential.
CredentialResponse	get(String guid, RequestOptions options)	Retrieve a credential.
CredentialTestResponse	test(Credential credential)	Test the provided credential, to confirm it works.
CredentialTestResponse	test(Credential credential, RequestOptions options)	Test the provided credential, to confirm it works.
CredentialResponse	update(String guid, Credential credential)	Update the provided credential in Atlan.
CredentialResponse	update(String guid, Credential credential, RequestOptions options)	Update the provided credential in Atlan.

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

Constructor Details

CredentialsEndpoint

public CredentialsEndpoint(AtlanClient client)

Method Details

get

public CredentialResponse get(String guid)
                       throws AtlanException

Retrieve a credential. Note that this will never contain sensitive information in the credential, such as usernames, passwords or client secrets or keys.

Parameters:

guid - unique identifier (GUID) of the credential

Returns:

non-sensitive information about the credential

Throws:

AtlanException - on any API communication issue

get

public CredentialResponse get(String guid,
 RequestOptions options)
                       throws AtlanException

Retrieve a credential. Note that this will never contain sensitive information in the credential, such as usernames, passwords or client secrets or keys.

Parameters:

guid - unique identifier (GUID) of the credential

options - to override default client settings

Returns:

non-sensitive information about the credential

Throws:

AtlanException - on any API communication issue

test

public CredentialTestResponse test(Credential credential)
                            throws AtlanException

Test the provided credential, to confirm it works.

Parameters:

credential - details of the credential to test

Returns:

the test results

Throws:

AtlanException - on any API communication issue

test

public CredentialTestResponse test(Credential credential,
 RequestOptions options)
                            throws AtlanException

Test the provided credential, to confirm it works.

Parameters:

credential - details of the credential to test

options - to override default client settings

Returns:

the test results

Throws:

AtlanException - on any API communication issue

update

public CredentialResponse update(String guid,
 Credential credential)
                          throws AtlanException

Update the provided credential in Atlan. Note that this will NOT test the credential first, so ensure it is valid before calling this method.

Parameters:

guid - unique identifier of the credential to update

credential - details of the credential to include in the update

Returns:

details of the updated credential

Throws:

AtlanException - on any API communication issue

update

public CredentialResponse update(String guid,
 Credential credential,
 RequestOptions options)
                          throws AtlanException

Update the provided credential in Atlan. Note that this will NOT test the credential first, so ensure it is valid before calling this method.

Parameters:

guid - unique identifier of the credential to update

credential - details of the credential to include in the update

options - to override default client settings

Returns:

details of the updated credential

Throws:

AtlanException - on any API communication issue