User class

This class represents a user of the BMC Cloud Lifecycle Management System.

User class APIs

The following tables list the basic APIs, operation APIs, and relationship APIs for the User class.

Basic APIs

Name

HTTP
method

URI

Description

createPOST
csm/User
Creates a User object.

delete

DELETE
csm/User/_guid_
Deletes a User object.

update

POST
csm/User/_guid_/update
Updates a User object.

search

POST

csm/User/search

Searches for User objects.

Operation APIs

 Name

HTTP
method

URI

Description

getPassword

POST

csm/User/_guid_/getPassword

This API returns password for the specified User

getQuota

POST

csm/User/_guid_/getQuota

Transfers the ownership from existing user to the new user

getQuotaUsage

POST

csm/User/_guid_/getQuotaUsage

Transfers the ownership from existing user to the new user.

setPassword

POST
csm/User/_guid_/setPassword 
This API sets password for the specified User

updateQuota

POST
csm/User/updateQuota
Transfers the ownership from existing user to the new user

validateQuota

POST
csm/User/_guid_/validateQuota
This API validates quota for the user. The validation is done across the requested services v/s the quota added earlier.

Relationship APIs

The User class has no relationship APIs.

User class relationships and attributes

The following tables list the relationships and attributes of the User class.

Relationships

Name

Type

Multi-
plicity

Description

organization
Organization

1..*

serviceOfferingInstances
ServiceOfferingInstance

0..*

userPrivileges
Privilege 
0..* 

cloudClass

CloudClass

1

Fully-qualified name of the class to which the object belongs

provider

Provider

1

Provider that created the object

tags

Tag

0..*

Tags associated with the object

Attributes

Name

Type

Multi-
plicity

Description

customFields

String

0..*

email

String

0..1

firstName

String

0..1

lastName

String

0..1

location

FoundationLocation

0..1

primaryOrganization

String

0..1

description

String

0..1

Text that describes the object

guid

String

1

Globally unique identifier for the object

labels

String

0..*

modifiedDate

Date

0..1

Date the Cloudobject was modified

name

String

1

Human-readable name of the object

HTTP request message

Query string parameters

This API does not use query string parameters.

Request message headers

This API uses only common headers listed in HTTP request and response headers.

Example

The following example shows an HTTP request for the API that represents a user of the BMC Cloud Lifecycle Management System.


{
                "timeout": 1000000,
                "operationParams": [{
                                "name": "user",
                                "value": {
                                                "cloudClass": "com.bmc.cloud.model.beans.User",
                                                "description": "create call",
                                                "firstName": "Nimbo",
                                                "lastName": "CloudUser1",
                                                "email": "test@bmc.com",
                                                
                                                "customFieldsObject": [{
                                                                "cloudClass": "com.bmc.cloud.model.beans.CustomField",
                                                                "name": "ctm_people.1000001437",
                                                                "description": "TemplateName",
                                                                "stringValue": "Cloud End User",
                                                                "type": "String"
                                                }],
                                                "name": "NimboCloudUser1",
                                                "password": "plaintext:password",
                                                "primaryOrganization": "NimboStratus Corp",
                                                "foundationLocationObject": {
                                                                "cloudClass": "com.bmc.cloud.model.beans.FoundationLocation",
                                                                "name": "Austin Site1"
                                                }
                                },
                                "type": "com.bmc.cloud.model.beans.User",
                                "multiplicity": "1"
                } ],
                "postCallout": "",
                "callbackURL": "",
                "preCallout": ""
}


Was this page helpful? Yes No Submitting... Thank you

Comments