com.cloudbees.plugins.credentials.cloudbees

Interface CloudBeesUser

All Superinterfaces:

com.cloudbees.plugins.credentials.Credentials, hudson.model.Describable<com.cloudbees.plugins.credentials.Credentials>, Serializable

All Known Subinterfaces:

CloudBeesUserWithAccountApiKey, CloudBeesUserWithPassword

All Known Implementing Classes:

AbstractCloudBeesUser

public interface CloudBeesUser
extends com.cloudbees.plugins.credentials.Credentials

Represents a CloudBees user's credentials

Method Summary

Methods

Modifier and Type	Method and Description
CloudBeesAccount	getAccount(String name) Returns the named CloudBees account or null if not found.
List<CloudBeesAccount>	getAccounts() Returns the CloudBees accounts that this user belongs to.
String	getAPIKey() Returns the API key for the user.
hudson.util.Secret	getAPISecret() Returns the Secret key for the user.
String	getDisplayName() Returns the full name of the user that the account belongs to (or getName() if that is not available).
String	getName() Returns the email address of the user (which is the name they login to CloudBees with).
String	getUID() Returns the UID of the user.

Methods inherited from interface com.cloudbees.plugins.credentials.Credentials

getDescriptor, getScope

Method Detail

getName

String getName()

Returns the email address of the user (which is the name they login to CloudBees with).

Returns:

the email address of the user (which is the name they login to CloudBees with).

getDisplayName

String getDisplayName()

Returns the full name of the user that the account belongs to (or getName() if that is not available).

Returns:

the full name of the user that the account belongs to.

getAPIKey

String getAPIKey()

Returns the API key for the user.

Returns:

the API key for the user.

getAPISecret

hudson.util.Secret getAPISecret()

Returns the Secret key for the user.

Returns:

the Secret key for the user.

getUID

String getUID()

Returns the UID of the user.

Returns:

the UID of the user.

getAccounts

List<CloudBeesAccount> getAccounts()

Returns the CloudBees accounts that this user belongs to.

Returns:

the CloudBees accounts that this user belongs to.

getAccount

CloudBeesAccount getAccount(String name)

Returns the named CloudBees account or null if not found.

Parameters:

name - the CloudBeesAccount.getName() of the account to find.

Returns:

the named CloudBees account or null if not found.