Target Operations
/AppSpiderEnterprise/rest/v1/Target/GetClientTargets Description Retrieves the list of targets for the client
Parameters
| Parameters | Type | Required | Description |
|---|---|---|---|
| clientId | guid[] | Y | The client Id |
Response Messages
| Response status code | Reason |
|---|---|
| 200 | |
| 400 | NotFound |
Response example:
{
"type": "object",
"properties": {
"Targets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Accounts": {
"type":"array",
"items": {
"type": "object",
"properties": {
"Status": {
"type":"string",
"required": true
},
"StatusNumber": {
"type":"integer",
"required": true
},
"Id": {
"type":"string",
"required": true
},
"Name": {
"type":"string",
"required": true
},
}
}
}
"Groups": {
"type":"array",
"items": {
"type": "object",
"properties": {
"Status": {
"type":"string",
"required": true
},
"StatusNumber": {
"type":"integer",
"required": true
},
"Id": {
"type":"string",
"required": true
},
"Name": {
"type":"string",
"required": true
},
}
}
}
"TargetGroups": {
"type":"array",
"items": {
"type": "object",
"properties": {
"Id": {
"type":"string",
"required": true
},
"Name": {
"type":"string",
"required": true
},
}
}
},
"ClientApproved": {
"type": "boolean",
"required": true
},
"HasPending": {
"type": "boolean",
"required": true
},
"Id": {
"type": "string",
"required": true
},
"Host": {
"type": "string",
"required": true
}
}
},
"additionalProperties": false
},
"IsSuccess": {
"type": "boolean",
"required": true
},
"ErrorMessage": {
"type":["string", "null"],
"required": true
},
"Reason": {
"type":["string", "null"],
"required": true
},
"Links": {
"type": "array",
"items": {
"Rel": {
"type":["string", "null"],
"required": true
},
"Href": {
"type":["string", "null"],
"required": true
}
}
}
},
},
"additionalProperties": false
}/AppSpiderEnterprise/rest/v1/Target/ClientApproval Description Approves the target for the client ONLY as System Admins
Request Parameters
| Parameters | Type | Required | Description |
|---|---|---|---|
| targetId | guid[] | Y | The target Id |
Request Body
| Parameters | Type | Required | Description |
|---|---|---|---|
| ClientId | guid[] | Y | The clientId |
| Status | string | Y | The status for the Target |
Request example:
{
"type": "object",
"properties": {
"ClientId": {
"type": "string",
"required": true
},
"Status": {
"type": "string"",
"required": true
}
},
}Response Messages
| Response status code | Reason | Description |
|---|---|---|
| 200 | Status for Target has been set | |
| 400 | Invalid Target Status |
Response example:
{
"type": "object",
"properties": {
"IsSuccess": {
"type": "boolean"",
"required": true
},
"ErrorMessage": {
"type":["string", "null"]",
"required": true
},
"Reason": {
"type": ["string", "null"]",
"required": true
},
"Links": {
"type": "array",
"items": {
"Rel": {
"type":["string", "null"],
"required": true
},
"Href": {
"type":["string", "null"],
"required": true
}
}
}
},
},
"additionalProperties": false
}/AppSpiderEnterprise/rest/v1/Target/AssignToUserGroup Description Assigns the user group to the target
Request Parameters
| Parameters | Type | Required | Description |
|---|---|---|---|
| targetId | guid[] | Y | The target Id |
Request Body
| Parameters | Type | Required | Description |
|---|---|---|---|
| GroupIdGroupId | guid[] | Y | The group Id |
Request example:
{
"type": "object",
"properties": {
"GroupId": {
"type": "string",
"required": true
}
},
}Response Messages
| Response status code | Reason | Description |
|---|---|---|
| 200 | UserGroup added to Target | |
| 400 | Group is not associated with Client |
Response example:
{
"type": "object",
"properties": {
"IsSuccess": {
"type": "boolean"",
"required": true
},
"ErrorMessage": {
"type":["string", "null"]",
"required": true
},
"Reason": {
"type": ["string", "null"]",
"required": true
}
},
}/AppSpiderEnterprise/rest/v1/Target/RemoveUserGroup Description Removes the user group from the target
Request Parameters
| Parameters | Type | Required | Description |
|---|---|---|---|
| targetId | guid[] | Y | The target Id |
Request Body
| Parameters | Type | Required | Description |
|---|---|---|---|
| GroupId | guid[] | Y | The group Id |
Request example:
{
"type": "object",
"properties": {
"GroupId": {
"type": "string",
"required": true
}
},
}Response Messages
| Response status code | Reason | Description |
|---|---|---|
| 200 | UserGroup removed from Target | |
| 400 | Group is not associated with Client |
Response example:
{
"type": "object",
"properties": {
"IsSuccess": {
"type": "boolean"",
"required": true
},
"ErrorMessage": {
"type":["string", "null"]",
"required": true
},
"Reason": {
"type": ["string", "null"]",
"required": true
}
},
}