DataCloud Management Topics

Other Resources

Community
Contact Support

Other Help Sets

Home
Data Integrator Migration
DataFlow
DataConnect

Preferences





Skip to end of metadata
Go to start of metadata

The user resource gives you access to view and manipulate the user entity using the CloudRest API.

The following actions are available through the user resource.

List Users

Returns a list of users associated with the current user (always returns a one-item list).

Use the GET method for this action.

URL

The following response types are available via the optional Accept header in your request:

  • application/xml (default)
  • application/json
  • text/xml

Parameters

Name
Type
Description
Required?
start
Integer
0-indexed ordinal of the first record to return.No.
max
Integer
Maximum number of records to return.No.
s
String

ID of the active session.

Optional if the sessionId cookie has been set.

Example

 Click here to expand...

Request

Response

Header
application/xml
application/json
text/xml

Find User

Returns details for a user by ID number or user name.

Use the GET method for this action.

URL

The following response types are available via the optional Accept header in your request:

  • application/xml (default)
  • application/json
  • text/xml

Parameters

Name
Type
Description
Required?
userid
Long
ID of the user to return.Yes. (Either userid or username is required.)
usernameStringUser name for the user to return.Yes. (Either userid or username is required.)
s
String
ID of the active session.Optional if the sessionId cookie has been set.

Example

 Click here to expand...

Request by ID

Request by Name

Response

Header
application/xml
application/json
text/xml

Edit User

Edit the parameters for the currently logged in user.

Use the POST method for this action. Supply the user object with the modified parameters in the body of your request.

URL

Parameters

Name
Type
Description
Required?
s
String
ID of the active session.Optional if the sessionId cookie has been set.

Example

 Click here to expand...

Request

Body

Response

Header

Create User

Create a new user.

Use the POST method for this action. Supply the user object with the modified parameters in the body of your request.

URL

Parameters

Name
Type
Description
Required?
s
String
ID of the active session.Optional if the sessionId cookie has been set.

Example

 Click here to expand...

Request

Body

Response

Header

 

  • No labels