com.cloudbees.api

Class CBUser

java.lang.Object

com.cloudbees.api.CBUser

public class CBUser
extends Object

Represetns an user in the CloudBees platform.

A user typically represents a human that can login to the system. One user can belong to multiple accounts, and vice versa.

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field and Description
List<CBAccount>	accounts
String	email
String	first_name
String	id Unique identifier of the user.
String	last_name
String	name This is the login ID, a short token without any whitespace, any special characters, etc.
PartiallyCreatedUser	partially_created This field is set by the server when you create an user with incomplete information, to indicate that the user was partially created and the rest of the registration needs to be completed by the user before the account becomes fully usable.
String	password
List<String>	roles
List<CBSshKey>	ssh_keys

Constructor Summary

Constructors

Constructor and Description
CBUser()

Method Summary

Methods

Modifier and Type	Method and Description
CBUser	createAccount(String name) Creates an account and add this user to it.
void	delete()
CBUser	update()

Methods inherited from class java.lang.Object

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

Field Detail

first_name

public String first_name

last_name

public String last_name

email

public String email

name

public String name

This is the login ID, a short token without any whitespace, any special characters, etc.

password

public String password

id

public String id

Unique identifier of the user. To be used for most of user management. Once created it can not be modified.

(This is not to be set in the request, but available in the response.)

roles

public List<String> roles

partially_created

public PartiallyCreatedUser partially_created

This field is set by the server when you create an user with incomplete information, to indicate that the user was partially created and the rest of the registration needs to be completed by the user before the account becomes fully usable.

accounts

public List<CBAccount> accounts

ssh_keys

public List<CBSshKey> ssh_keys

Constructor Detail

CBUser

public CBUser()

Method Detail

createAccount

public CBUser createAccount(String name)
                     throws IOException

Creates an account and add this user to it.

Throws:

IOException

delete

public void delete()
            throws IOException

Throws:

IOException

update

public CBUser update()
              throws IOException

Throws:

IOException