com.dtolabs.rundeck.core.authentication.tokens

Interface AuthTokenManager

public interface AuthTokenManager

Manage Rundeck API authentication tokens

Method Summary

Modifier and Type	Method and Description
boolean	deleteToken(java.lang.String token) Delete an authentication token
AuthenticationToken	getToken(java.lang.String token) Retrieve token information from storage
boolean	importWebhookToken(com.dtolabs.rundeck.core.authorization.UserAndRolesAuthContext authContext, java.lang.String token, java.lang.String user, java.util.Set<java.lang.String> roleSet) Import a Webhook type api token
java.util.Set<java.lang.String>	parseAuthRoles(java.lang.String authRoles) Parse a comma separated list of roles into a role Set
boolean	updateAuthRoles(com.dtolabs.rundeck.core.authorization.UserAndRolesAuthContext authContext, java.lang.String token, java.util.Set<java.lang.String> roleSet) Update the roles associated with the authentication token

Method Detail

getToken

AuthenticationToken getToken(java.lang.String token)

Retrieve token information from storage

Parameters:

token - The token string that identifies the token

Returns:

AuthenticationToken

updateAuthRoles

boolean updateAuthRoles(com.dtolabs.rundeck.core.authorization.UserAndRolesAuthContext authContext,
                        java.lang.String token,
                        java.util.Set<java.lang.String> roleSet)
                 throws java.lang.Exception

Update the roles associated with the authentication token

Parameters:

token - token id

roleSet - the new list of roles

Returns:

true if the update completed successfully

Throws:

java.lang.Exception

deleteToken

boolean deleteToken(java.lang.String token)

Delete an authentication token

Parameters:

token - token identifier

Returns:

true if the update completed successfully

parseAuthRoles

java.util.Set<java.lang.String> parseAuthRoles(java.lang.String authRoles)

Parse a comma separated list of roles into a role Set

Parameters:

authRoles - String of roles separated by a comma

Returns:

A unique set of roles

importWebhookToken

boolean importWebhookToken(com.dtolabs.rundeck.core.authorization.UserAndRolesAuthContext authContext,
                           java.lang.String token,
                           java.lang.String user,
                           java.util.Set<java.lang.String> roleSet)
                    throws java.lang.Exception

Import a Webhook type api token

Parameters:

token - token id

user - the user that is represented by this auth token

roleSet - set of roles for the auth token

Returns:

true if the update completed successfully

Throws:

java.lang.Exception