User Management API

Version 24.2.8969


User Management API


The User Management API supports the following actions:

The sections below describe each of these actions.

Note: When you create or modify users, you must use the API role name. The following table maps the user roles to their API equivalents.

User Role Name API Role Name
Admin cdata_admin
Standard cdata_standard
Job Creator cdata_job_creator
Job Operator cdata_support

Create a User

The following command creates a user in the CData Sync application:

POST http://MyDomain.com:8019/api.rsc/users

Body Parameters

Name Description
User Specifies the user identifier.
Active Specifies whether the user is active.
Password Specifies the user password.
Roles Specifies the user’s role.
FederationId Specifies the federation Id for SSO authentication.

Example

{ 
  "User": "APIUser",
  "Active": true,
  "Password": "APIUser",
  "Roles":  "cdata_admin"
}

Create Multiple Users

The following command creates multiple users in the Sync application:

POST http://MyDomain.com:8019/api.rsc/createUsers

Body Parameters

Name Description
User Specifies the user identifier.
Active Specifies whether the user is active.
Password Specifies the user password.
Roles Specifies the user’s role.
FederationId Specifies the federation Id for SSO authentication.

Example

{ 
  "User1": "APIUser1",
  "Password#1": "APIUser1$",
  "Roles#1": "cdata_admin",
  "FederationId#1": "User1Id",
  "User#2": "APIUser2", 
  "Password#2": "APIUser2$",
  "Roles#2": "cdata_admin",
  "FederationId#1": "User2Id"
}

List All Users

The following command returns a list of all users within the CData Sync application.

GET http://MyDomain.com:8019/api.rsc/users(Name)

Query Parameter

Name Description
User Specifies the name of the user to retrieve.

Modify a User

The following command modifies an existing user. You can modify only the User, ExpiredIn, Active, and Roles fields.

PUT http://MyDomain.com:8019/api.rsc/users(Name)

Query Parameter

Name Description
User (required) Specifies the name of the user to modify.

Body Parameters

Name Description
User Specifies the user’s name.
Password Specifies the user’s password.
Active Specifies whether the user is active.
ExpiredIn Specifies the number of days until the Auth token expires.
Roles Specifies the user’s role.

Example

{ 
  "User": "MyUser",
  "Password": "MyPassword",
  "Active": true,
  "ExpiredIn": 100,
  "Roles": "cdata_standard"
}