skip to main content
User-Provisioning API : Create a User Account
 

Try DataDirect Cloud Now

Create a User Account

Title

Create a user account.

Purpose

Creates a user account on DataDirect Cloud with the details provided in the server payload.

URL

https://service.datadirectcloud.com/api/mgmt/users

Method

POST

Payload Parameters

Parameter
Data Type
Description
Usage
Valid Values
loginId
String
The login ID of the end user. The value must be unique across all DataDirect Cloud.
Required
The login ID may only contain letters [a-z, A-Z], numbers [0-9], and non-leading characters: - . @ _.
parentId
String
The parent ID of the end user
Required
password
String
The password of the end user
Required
The passwords must be at least 8 characters in length.
The password can only contain letters [a-z, A-Z], and numbers [0-9]. It must not have spaces.
The password must not contain any portion of the user's login ID. A portion is any three characters occurring sequentially in any part of the login ID.
passwordStatus
String
Status of the user's password
Optional
ACTIVE | RESET REQUIRED
passwordPolicy
Object
Policies related to the password
Optional
maxPasswordAge
Long
Number of days after which the password will expire
Optional
Non negative integer
accountStatus
String
Status of the user account
Optional
ACTIVE | INACTIVE Default: ACTIVE
eval
Boolean
Set to true for an INDIVIDUAL evaluation account. Refer to "Types of user accounts".
Optional
true | false
Default: true for INDIVIDUAL accounts.
For all other account types, the only valid value is false.
evalDuration
Long
Evaluation duration in days
Optional
Default: 30 days
entitlements
Array
Entitlements that you want to associate with the user account
Optional
Data Transfer, PurchasedDataStores
ignoreLimits
Boolean
Specifies if the usage can extend the limit specified in an entitlement
Optional
true | false
Default: false
type
String
Type of user account
Optional
INDIVIDUAL | CORPORATE | CORPORATE_USER | PARTNER | PARTNER_USER
Default: INDIVIDUAL

Sample Server Payload

The following request creates an evaluation account on DataDirect Cloud and provides access to Salesforce, Rollbase, Apache Hadoop Hive, DB2, and Oracle Marketing Cloud data stores with 800 MB of data transfer.
{
"loginId":"eval102",
"parentId":"mainoemadmin2",
"password":"sample",
"type":"INDIVIDUAL",
"eval":true,
"accountStatus":"ACTIVE",
"ignoreLimits":false,
"entitlements":[
{
"name":"Data Transfer",
"value":"800",
"extraInfo":""
},
{
"name": "PurchasedDataStores",
"value": "Salesforce,Rollbase,Apache Hadoop Hive,DB2,Oracle Marketing Cloud"
}
]
"passwordPolicy":{
"maxPasswordAge":120
},
"passwordStatus":"ACTIVE",
}
}

Sample Server Success Response

{
"loginId": "eval102",
"statusMsg": 'User created successfully'
}

Sample Server Failure Response

If the Administrator's credentials are not valid, the following exception is thrown:
{
"loginId": "eval102",
"errorCode": 1001,
"errorMsg": "Unauthorized to perform this operation"
}
If the request payload has an invalid value, the following exception is thrown:
{
"loginId": "eval102",
"errorCode": 2001,
"errorMsg":"Unsupported value provided for property 'type'",
}

Authentication

Basic Auth using login ID and password.

Authorization

Accessible to the DataDirect Cloud Administrator.