Import Users

Import Users
Import users from the auth source

Auth source can be SSO/VIDM/LDAP/AD/VIDB.
When a user is being re-imported, make sure to populate the "id" field of the user.
NOTE: In the case of vIDB users, the import occurs based on the provided externalId. If other provided details are incorrect, they will be asynchronously updated with the correct values right after the import operation is completed.

Request
URI
POST
https://{api_host}/suite-api/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 
"{\n  \"users\" : [ {\n    \"username\" : \"alexr\",\n    \"firstName\" : \"alex\",\n    \"lastName\" : \"richard\",\n    \"password\" : null,\n    \"emailAddress\" : \"[email protected]\",\n    \"distinguishedName\" : \"CN=USER,OU=PAO_Users,OU=PaloAlto_California_USA,OU=NALA,OU=SITES,OU=Engineering,DC=broadcom,DC=com\",\n    \"enabled\" : false,\n    \"roleNames\" : [ \"Administrator\" ],\n    \"role-permissions\" : [ {\n      \"roleName\" : \"Administrator\",\n      \"traversal-spec-instances\" : [ {\n        \"adapterKind\" : \"adap_kind\",\n        \"resourceKind\" : \"resource_kind\",\n        \"name\" : \"traversal_spec_name\",\n        \"selectAllResources\" : true\n      } ],\n      \"allowAllObjects\" : true\n    } ],\n    \"lastLoginTime\" : 0\n  }, {\n    \"username\" : \"bobw\",\n    \"firstName\" : \"bob\",\n    \"lastName\" : \"williams\",\n    \"password\" : null,\n    \"emailAddress\" : \"[email protected]\",\n    \"distinguishedName\" : \"CN=USER,OU=PAO_Users,OU=PaloAlto_California_USA,OU=NALA,OU=SITES,OU=Engineering,DC=broadcom,DC=com\",\n    \"enabled\" : false,\n    \"roleNames\" : [ \"Administrator\" ],\n    \"role-permissions\" : [ {\n      \"roleName\" : \"Administrator\",\n      \"traversal-spec-instances\" : [ {\n        \"adapterKind\" : \"adap_kind\",\n        \"resourceKind\" : \"resource_kind\",\n        \"name\" : \"traversal_spec_name\",\n        \"selectAllResources\" : true\n      } ],\n      \"allowAllObjects\" : true\n    } ],\n    \"lastLoginTime\" : 0\n  } ]\n}"
array of object
users
Optional

List of users

Authentication
This operation uses the following authentication methods.
Responses
201

List of users successfully imported

Returns user-list of type(s) application/json 
"{\n  \"users\" : [ {\n    \"id\" : \"5266170c-511d-4e87-9567-dd7fc418d33b\",\n    \"username\" : \"alexr\",\n    \"firstName\" : \"alex\",\n    \"lastName\" : \"richard\",\n    \"password\" : null,\n    \"emailAddress\" : \"[email protected]\",\n    \"distinguishedName\" : \"CN=USER,OU=PAO_Users,OU=PaloAlto_California_USA,OU=NALA,OU=SITES,OU=Engineering,DC=broadcom,DC=com\",\n    \"enabled\" : false,\n    \"roleNames\" : [ \"Administrator\" ],\n    \"role-permissions\" : [ {\n      \"roleName\" : \"Administrator\",\n      \"traversal-spec-instances\" : [ {\n        \"adapterKind\" : \"adap_kind\",\n        \"resourceKind\" : \"resource_kind\",\n        \"name\" : \"traversal_spec_name\",\n        \"selectAllResources\" : true\n      } ],\n      \"allowAllObjects\" : true\n    } ],\n    \"lastLoginTime\" : 0\n  }, {\n    \"id\" : \"77dc7b85-1644-43dd-bc4a-cc10aa8ac991\",\n    \"username\" : \"bobw\",\n    \"firstName\" : \"bob\",\n    \"lastName\" : \"williams\",\n    \"password\" : null,\n    \"emailAddress\" : \"[email protected]\",\n    \"distinguishedName\" : \"CN=USER,OU=PAO_Users,OU=PaloAlto_California_USA,OU=NALA,OU=SITES,OU=Engineering,DC=broadcom,DC=com\",\n    \"enabled\" : false,\n    \"roleNames\" : [ \"Administrator\" ],\n    \"role-permissions\" : [ {\n      \"roleName\" : \"Administrator\",\n      \"traversal-spec-instances\" : [ {\n        \"adapterKind\" : \"adap_kind\",\n        \"resourceKind\" : \"resource_kind\",\n        \"name\" : \"traversal_spec_name\",\n        \"selectAllResources\" : true\n      } ],\n      \"allowAllObjects\" : true\n    } ],\n    \"lastLoginTime\" : 0\n  } ]\n}"
array of object
users
Optional

List of users


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/suite-api/api/auth/sources/{id}/users
On This Page
Auth Operations
GET
Get Current User
GET
Get Assigned Role Permissions For Current User
GET
Get Current User Role Privileges
GET
Get Available Privilege Groups
GET
Get Available Privileges
GET
Get Roles
POST
Create User Role
PUT
Update User Role
DELETE
Delete User Role
GET
Get Role By Name
DELETE
Remove Role Privileges
GET
Get Role Privileges
POST
Add Role Privileges
PUT
Set Role Privileges
DELETE
Delete Scopes
GET
Get All Object Scopes
POST
Create Scope
PUT
Modify Scope
GET
Get Scope
GET
Get Auth Sources
PATCH
Patch Auth Source With Certificate Details
POST
Add Auth Source
PUT
Update Auth Source
PATCH
Patch Test Auth Source
POST
Test Auth Source
GET
Get VIDB Well Known URL
POST
Search User Groups For Auth Source
PUT
Synchronize User Groups
POST
Import Users
POST
Search Users For Auth Source
DELETE
Delete Auth Source
GET
Get Auth Source
GET
Get Auth Source Types
GET
Get Auth Source Type
POST
Acquire Token
POST
Exchange Ops Token With Jwt Token
POST
Release Token
GET
Get Traversal Specs
DELETE
Delete User Groups
GET
Get User Groups
POST
Create User Group
PUT
Modify User Group
GET
Get Assigned Role Permissions For User Group
PUT
Assign Role Permission To User Group
DELETE
Unassigned Role Permission From User Group
PUT
Assign Traversal Spec To User Group
Deprecated
DELETE
Delete User Group
GET
Get User Group
DELETE
Delete Users
GET
Get Users
POST
Create User
PUT
Modify User
PUT
Change Password
DELETE
Delete User
GET
Get User
GET
Get Assigned Role Permissions For User
PUT
Assign Role Permission To User
DELETE
Unassigned Role Permission From User
PUT
Assign Traversal Spec To User
Deprecated