Print Download PDF Send Feedback

Previous

Next

Bulk Commands (v1.0)

You can use a bulk command to send multiple commands in one request. To do this, send the bulk command with a requests array, in which each array element contains the parameters of one request. The response returns a responses array, in which each array element contains the response for one command. The responses appear in the order of the requests.

Request 1: Adding multiple associations

{

"shared-secret" : "****",

"requests":[

{"user":"linda","machine":"","ip-address":"1.1.18.1"},

{"user":"james","ip-address":"1.1.18.2", "domain" : "cme.com"},

{"user":"mary","machine":"","ip-address":"1.1.18.3"}

]

}

Response 1: Added multiple associations

{

"responses":[

{

"ipv4-address":"1.1.18.1",

"message":"Association sent to PDP."

},

{

"ipv4-address":"1.1.18.2",

"message":"Association sent to PDP."

},

{

"ipv4-address":"1.1.18.3",

"message":"Association sent to PDP."

}

]

}

Request 2: Adding multiple associations, one of which is incorrect

{

"shared-secret":"****",

"requests":[

{"user":"john","machine":"","ip-address":"1.1.18.1"},

{"user":"linda","ip-address":"invalid", "domain" : "cme.com"},

{"user":"james","machine":"","ip-address":"1.1.18.3"}

]

}

Response 2: Corresponding return values

{

"responses": [

{

"ipv4-address": "1.1.18.1",

"message": "Association sent to PDP."

},

{

"code": "GENERIC_ERR_INVALID_PARAMETER",

"message": "No valid IP was provided"

},

{

"ipv4-address": "1.1.18.3",

"message": "Association sent to PDP."

}

]

}

Request 3: Request multiple identities

{

"shared-secret":"****",

"requests":[

{"ip-address":"1.1.18.1"},

{"ip-address":"1.1.18.2"},

{"ip-address":"1.1.18.3"}

]

}

Response 3: Returned identities

{

"responses":[

{

"combined-roles":[],

"ipv4-address":"1.1.18.1",

"message":"total 1 user records were found.",

"users":[

{

"groups":[

"All Users"

],

"identity-source": "AD Query",

"roles":[],

"user":"User 1"

}

]

},

{

"combined-roles":[],

"domain":"cme.com",

"ipv4-address": "1.1.18.2",

"message":"total 1 user records were found.",

"users":[

{

"groups":[

"All Users"

],

"identity-source": "AD Query",

"roles":[],

"user":"User 2"

}

]

},

{

"combined-roles": [],

"ipv4-address": "1.1.18.3",

"message": "total 1 user records were found.",

"users":[

{

"groups": [],

"identity-source": "AD Query",

"roles": [],

"user": "User 3"

}

]

}

]

}