Version 23.4.8843

• Create a User
  • Body Parameters
  • Example
• Create Multiple Users
  • Body Parameters
  • Example
• List All Users
  • Query Parameter
• Modify a User
  • Query Parameter
  • Body Parameters
  • Example

The User Management API supports the following actions:

• Create a user
• Create multiple users
• List all users
• Modify a user

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.

Create a User

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

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

Body Parameters

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

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

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

Body Parameters

Example

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