Import Users Using POST
Auth source can be SSO/VIDM/LDAP/AD. When a user is being re-imported, make sure to populate the "id" field of the user.
Request
URI
POST
https://{api_host}/api/auth/sources/{id}/users
COPY
Path Parameters
string
id
Required
The ID of the Auth source
Request Body
The List of users to be imported
user-list of type(s) application/json
Required
{
"users": [
{
"Last login time": 0,
"distinguishedName": "string",
"emailAddress": "string",
"enabled": false,
"firstName": "string",
"groupIds": [
"string"
],
"id": "string",
"lastName": "string",
"links": [
{
"description": "string",
"href": "string",
"name": "string",
"rel": "string"
}
],
"password": "string",
"role-permissions": [
{
"allowAllObjects": false,
"links": [
{
"description": "string",
"href": "string",
"name": "string",
"rel": "string"
}
],
"roleName": "string",
"traversal-spec-instances": [
{
"adapterKind": "string",
"includedAdapterKinds": [
"string"
],
"name": "string",
"resourceKind": "string",
"resourceSelection": [
{
"resourceId": [
"string"
],
"type": "string"
}
],
"selectAllResources": false
}
]
}
],
"roleNames": [
"string"
],
"username": "string"
}
]
}
Responses
201
List of users successfully imported
Returns user-list of type(s) application/json
{
"users": [
{
"Last login time": 0,
"distinguishedName": "string",
"emailAddress": "string",
"enabled": false,
"firstName": "string",
"groupIds": [
"string"
],
"id": "string",
"lastName": "string",
"links": [
{
"description": "string",
"href": "string",
"name": "string",
"rel": "string"
}
],
"password": "string",
"role-permissions": [
{
"allowAllObjects": false,
"links": [
{
"description": "string",
"href": "string",
"name": "string",
"rel": "string"
}
],
"roleName": "string",
"traversal-spec-instances": [
{
"adapterKind": "string",
"includedAdapterKinds": [
"string"
],
"name": "string",
"resourceKind": "string",
"resourceSelection": [
{
"resourceId": [
"string"
],
"type": "string"
}
],
"selectAllResources": false
}
]
}
],
"roleNames": [
"string"
],
"username": "string"
}
]
}
On This Page
Auth Operations
POST
Acquire Token Using POST
POST
Add Auth Source Using POST
POST
Add Role Privileges Using POST
PUT
Assign Role Permission To User Group Using PUT
PUT
Assign Role Permission To User Using PUT
PUT
Assign Traversal Spec To User Group Using PUT
Deprecated
PUT
Assign Traversal Spec To User Using PUT
Deprecated
PUT
Change Password Using PUT
POST
Create User Group Using POST
POST
Create User Role Using POST
POST
Create User Using POST
DELETE
Delete Auth Source Using DELETE
DELETE
Delete User Groups Using DELETE
DELETE
Delete User Group Using DELETE
DELETE
Delete User Role Using DELETE
DELETE
Delete Users Using DELETE
DELETE
Delete User Using DELETE
GET
Get Assigned Role Permissions For Current User Using GET
GET
Get Assigned Role Permissions For User Group Using GET
GET
Get Assigned Role Permissions For User Using GET
GET
Get Auth Sources Using GET
GET
Get Auth Source Types Using GET
GET
Get Auth Source Type Using GET
GET
Get Auth Source Using GET
GET
Get Available Privilege Groups Using GET
GET
Get Available Privileges Using GET
GET
Get Current User Role Privileges Using GET
GET
Get Current User Using GET
GET
Get Role By Name Using GET
GET
Get Role Privileges Using GET
GET
Get Roles Using GET
GET
Get Traversal Specs Using GET
GET
Get User Groups Using GET
GET
Get User Group Using GET
GET
Get Users Using GET
GET
Get User Using GET
POST
Import Users Using POST
PUT
Modify User Group Using PUT
PUT
Modify User Using PUT
PATCH
Patch Auth Source With Certificate Details Using PATCH
PATCH
Patch Test Auth Source Using PATCH
POST
Release Token Using POST
DELETE
Remove Role Privileges Using DELETE
POST
Search User Groups For Auth Source Using POST
POST
Search Users For Auth Source Using POST
PUT
Set Role Privileges Using PUT
PUT
Synchronize User Groups Using PUT
POST
Test Auth Source Using POST
DELETE
Unassigned Role Permission From User Group Using DELETE
DELETE
Unassigned Role Permission From User Using DELETE
PUT
Update Auth Source Using PUT
PUT
Update User Role Using PUT