...

1. Search users in a domain

   Code Block
   language js title Parameters
   { "match": [     [domain.id", "=", "domain id 1"], ], "return":["id", "loginName", "email"], "sort":"name", "order":"asc", "max": 20, "offset": 0 }

   
   

   Code Block
   language js title Response
   { "error":0, "result": { "total": 20, "rows": [ {     "id":"user id 1",         "loginName":"John Smith", "email": "john.smith@acme.com" } }, {     "id":"user id 2",         "loginName":"Alice Smith", "email": "alice.smith@acme.com" }, ... ] } }

   
   

2. Search users in a unit

   Code Block
   language js title Parameters
   { "match": [     [unit.id", "=", "unit id 1"], ], "return":["id", "loginName", "email"], "sort":"name", "order":"asc", "max": 20, "offset": 0 }

   
   

   Code Block
   language js title Response
   { "error":0, "result": [{ {     "total": 20, " "rows": [ {     "id":"user id 1",         "loginName":"John Smith", "email": "john.smith@acme.com" }, {     "id":"user id 3",         "loginName":"Bob Smith", "email": "bob.smith@acme.com" }, ... ] } }

   
   

3. Search users in a group

   Code Block
   language js title Parameters
   { "match": [     [group.id", "=", "group id 1"], ], "return":["id", "loginName", "email"], "sort":"name", "order":"asc", "max": 20, "offset": 0 }

   
   

   Code Block
   language js title Response
   { "error":0, "result": [{ {     "total": 20, "idrows":"user id 1",         "loginName":"John Smith",[ "email": "john.smith@acme.com"{     }, {     "id":"user id 31",         "loginName":"BobJohn Smith", "email": "bobjohn.smith@acme.com" }, ... ] }

...

...

1. {

...

1. "id":"user id 2",         "loginName":"Alice Smith", "email": "alice.smith@acme.com" }, ... ] } }

   
   

Anchor
_Toc341972410 _Toc341972410

/user/get

Method: /user/get

{
    "match":
    [
         [domain.id", "=", "domain id 1"],
    ],
    "return":["id", "loginName", "email"],
    "sort":"name",
    "order":"asc",
    "max": 20,
    "offset": 0
}

{
    "error":0,
    "result":
    [
    	{
            "id":"user id 1", 
            "loginName":"John Smith",
            "email": "john.smith@acme.com"
     	},
     	{
            "id":"user id 2", 
            "loginName":"Alice Smith",
            "email": "alice.smith@acme.com"
     	}, 
     	...
    ]
}

Anchor
_Toc341972411 _Toc341972411

/user/set

Method:/user/set

{
    "id":"user id 1",
    "attrs": {"email": 

...

"john.smith@acme.com"}
}

...

...

{

...

    "error":0

...

}

Anchor
_Toc341972412 _Toc341972412

/user/delete

Method:/user/delete/delete

...

{

...

    "id":"user id 1

...

"
}

...

{

...

    "error":0

...

}

Other methods:
Unit

1. moveUnit

...

Anchor
_Toc341972413 _Toc341972413

/user/joinGroup

...

Method:

...

/user/joinGroup

Code Block
language js title Parameters
{ Parameters: \{ "user":\{"id":1\}, "groups": \ [ \ {"id":5\"id1"}, \        {"id":6\}, \{"id":7\} \"id2"} ],    "action":"join | unjoin" \} Response: \{ }

Code Block
language js title Response
{ "error":0 \} \\ \\ +Role+

1. assignRole(assign/unassign)

...

Anchor
_Toc341972414 _Toc341972414

/user/assignToken

Method: /user/assignToken
Assign an existing token

...

{

...

    "user

...

":

...

{"

...

id":

...

"user id 1"},
    "token:

...

    {
        "id":"token 5

...

",
        "product.manufactureCode":mc,

...

        "product.productCode":pc,

...

        "serial":xxx,

...

    },

...

    "credential":

...

 //

...

 optional
    {
        "otp":

...

 "xxxx"
    },
    "autoAssign":true|false,

...

    "action":"assign | unassign",

...

    "isOwner":true | false,

...

    "starts":xxx,

...

    "expires":xxx,

...

    "usageLimit":50,

...

    "status":"active | inactive | disabled",

...

    "pin":"the token pin"

...

}

...

{
    "error":0,

...

    "id":"tokenAssignmentId

...

"
}

Anchor
_Toc341972415 _Toc341972415

/user/resetPassword

Method: /user/assignToken
Assign an existing token
Parameters:
{
resetPassword

{
    "user":{"id":"user id 1"},

...

    "attrs":

...

    {
        "password":"new password",

...

        "userMustChangePassword":true|false

...

    }
}

{
    "error":0

...

}

Anchor
_Toc341972416 _Toc341972416

/user/getMessageTemplate

Examples:
Method:/user/getMessageTemplate
Parameters:
{
"user":
{
"domain.name":"xxx"
"loginName":"abc"
},

{
    "user":{"id":"user id 1"},
    "templateItemName":"SMTP_OTP"

...

}

...

{

...

    "error":0,

...

    "result":"template in json string"

...

}

Anchor
_Toc341972417 _Toc341972417

/user/ listProvisioningUrls

...

...

/user/ listProvisioningUrls

{
     listProvisioningUrls
\\
Parameters: 
\{
"user": 
\{
 "domain.nameid":"xxx"
"loginName":"abc"
\}
\}
Response: 
\{
 user id 1"}
}

{
    "error":0,
    "result":
\    {
        "total": 2,
"rows":
\[
 "[        "rows":
        [
            "http://provioning.deepnetsecurity.local:8072|http://provioning.deepnetsecurity.local:8072]",
            "http://provioning2.deepnetsecurity.local:8073"
\        ]
\    }
\}
\\

Anchor
_Toc341972418 _Toc341972418

/user/import

This method is a task running in the background
Examples:
Method:/user/import/import

...

{

...

    "attrs":

...

    {
        "format":"csv or xml",

...

        "data":"...",

...

        "charset":"UTF-8

...

"// optional
    }
}

{
    "error":0

...

}

Anchor
_Toc341972419 _Toc341972419

/user/issueCertificate

Method:/user/issueCertificate

...

{
    "user":{"id":"user id 1"},
    "csr":"csr data",
    "return":
    [
       "id", "subjectDn"
    ]
}

{
    "error":0,
    "result":
    {
        "id": "cert id",
        "subjectDn": "the subject dn"
    }
}

Anchor
_Toc341972420 _Toc341972420

/user/importCertificate

Method:/user/importCertificate

...

{
    "user":{"id":"user id 1"},
    "certificate":
    {
        "data":"data in PEM format"
    },
    "return":
    [
       "id", "subjectDn"
    ]
}

{
    "error":0,
    "result":
    {
        "id": "cert id",
        "subjectDn": "the subject dn"
    }
}

Anchor
_Toc341972421 _Toc341972421

/user/deleteCertificate

Method:/user/deleteCertificate

...

{

...

    "user":

...

{

...

"

...

id":"

...

user id 1"},
    "certificate":

...

    {
        "id":"cert

...

 id"
    }
}

{
    "error":0

...

}

Anchor
_Toc341972422 _Toc341972422

/user/getPolicy

...

Method: /user/getPolicy

{
   
Parameters: 
\{
 "user":
\{
"loginNameid":"login name",
"domain.id":domainid
\user id 1"},
    "category":
\    {
       "name":"logon"
\    },
    "return":\["name", "id","options"\]
\}
}

{
    Response: 
\{
 "error":0,
    "result":
\{
    {
        "id": "1policy id",
        "name": "Systempolicy logon policyname",
        "options":
\{
 "key":"valueoptions",
...
\}
\
    }
\}
\\
\\
\\