Share this page
Create a site user
Description
Creates a new site user and retrieves the user properties.
URL
/qcbin/v2/sa/api/site-users
HTTP Method
POST
Remarks
To create a new domain, POST a string compliant with the Site users schema reference that contains following fields:
name (Required)
full-name
phone
password
description
is-active
email
user-auth-data (required for LDAP - available from ALM 15.0.1)
idp-name (required for SSO)
identity-key (required for SSO)
Content-Type: application/xml, application/json
Accept: application/xml, application/json
Returns
On success, the HTTP return value is 201.
On success, returns the full data of the created domain in an XML/JSON string compliant with the Site users schema reference.
Input Example
Content-Type: application/json
{
"user": {
"name": "newuser",
"phone": "123456",
"idp-name": "idp-name",
"password": "user-password",
"description": "create a user",
"is-active": true,
"identity-key": "identityKey",
"full-name": "full name for new user",
"email": "newuser@mf.com",
"user-auth-data": {
"user-dn": "CN=appsadmin, CN=Users, DC=almdomain, DC=wlab, DC=net",
"user-id": 253,
"server-id": 1
}
}
}
Return Value Example
Accept: application/json
{
"user": {
"expire-date": "",
"phone": 123456,
"idp-name": "idp-name",
"name": "newuser",
"description": "create a user",
"is-active": true,
"id": 6,
"identity-key": "identityKey",
"full-name": "full name for new user",
"email": "newuser@mf.com"
}
}
