Account Operations

Credential Warning

Note: Sys Admin or Client Admin account permissions required to execute account operations. Sys Admin have full control over operations Client Admin can only administer their accounts within their client and cannot add or remove a user's clients

get

/AppSpiderEnterprise/rest/v1/Account/GetAccount?accountId=<accountid></accountid>

Description

Retrieves a user account

Parameters

Name

Type

Required

Description

accountId

guid

Y

request parameter id of the account to return

Response Messages

Response Status Code

Reason

Description

200

Success

Response contains the account info

400

Failure

No account found

Response example:

JSON schema:
1
{ 
2
  "type": "object",
3
  "properties": {
4
    "Account": {
5
      "type": "object",
6
      "properties": {
7
        "UserName": {
8
          "type": "string"
9
        },
10
        "Password": {
11
          "type": "null"
12
        },
13
        "FirstName": {
14
          "type": "string"
15
        },
16
        "LastName": {
17
          "type": "string"
18
        },
19
        "DefaultTimeZone": {
20
          "type": "string"
21
        },
22
        "Email": {
23
          "type": "string"
24
        },
25
        "Enabled": {
26
          "type": "boolean"
27
        },
28
        "Locked": {
29
          "type": "boolean"
30
        },
31
        "External": {
32
          "type": "boolean"
33
        },
34
        "Clients": {
35
          "type": "array",
36
          "items": [
37
            {
38
              "type": "object",
39
              "properties": {
40
                "Roles": {
41
                  "type": "array",
42
                  "items": [
43
                    {
44
                      "type": "object",
45
                      "properties": {
46
                        "RoleId": {
47
                          "type": "string"
48
                        },
49
                        "RoleName": {
50
                          "type": "string"
51
                        }
52
                      },
53
                      "required": [
54
                        "RoleId",
55
                        "RoleName"
56
                      ]
57
                    }
58
                  ]
59
                },
60
                "NotInRoles": {
61
                  "type": "array",
62
                  "items": [
63
                    {
64
                      "type": "object",
65
                      "properties": {
66
                        "RoleId": {
67
                          "type": "string"
68
                        },
69
                        "RoleName": {
70
                          "type": "string"
71
                        }
72
                      },
73
                      "required": [
74
                        "RoleId",
75
                        "RoleName"
76
                      ]
77
                    }
78
                  ]
79
                },
80
                "Groups": {
81
                  "type": "array",
82
                  "items": {}
83
                },
84
                "ClientInfo": {
85
                  "type": "object",
86
                  "properties": {
87
                    "ClientId": {
88
                      "type": "string"
89
                    },
90
                    "ClientName": {
91
                      "type": "string"
92
                    }
93
                  },
94
                  "required": [
95
                    "ClientId",
96
                    "ClientName"
97
                  ]
98
                }
99
              },
100
              "required": [
101
                "Roles",
102
                "NotInRoles",
103
                "Groups",
104
                "ClientInfo"
105
              ]
106
            }
107
          ]
108
        },
109
        "UserId": {
110
          "type": "string"
111
        }
112
      },
113
      "required": [
114
        "UserName",
115
        "Password",
116
        "FirstName",
117
        "LastName",
118
        "DefaultTimeZone",
119
        "Email",
120
        "Enabled",
121
        "Locked",
122
        "External",
123
        "Clients",
124
        "UserId"
125
      ]
126
    },
127
    "IsSuccess": {
128
      "type": "boolean"
129
    },
130
    "Reason": {
131
      "type": "null"
132
    },
133
    "ErrorMessage": {
134
      "type": "null"
135
    },
136
    "Links": {
137
      "type": "array",
138
      "items": [
139
        {
140
          "type": "object",
141
          "properties": {
142
            "Rel": {
143
              "type": "string"
144
            },
145
            "Href": {
146
              "type": "string"
147
            }
148
          },
149
          "required": [
150
            "Rel",
151
            "Href"
152
          ]
153
        }
154
      ]
155
    }
156
  },
157
  "required": [
158
    "Account",
159
    "IsSuccess",
160
    "Reason",
161
    "ErrorMessage",
162
    "Links"
163
  ]
164
}
get

/AppSpiderEnterprise/rest/v1/Account/GetAccount?userName=<username></username>

Description Retrieves the account for the username

Parameters

Parameters

Type

Required

Description

userName

string

Y

The username

Response Messages

Response status code

Reason

Description

200

Success

Response contains the account info for that username

400

Failure

No account found

Response example:

json
1
{ 
2
  "type": "object",
3
  "properties": {
4
    "Account": {
5
      "type": "object",
6
      "properties": {
7
        "UserName": {
8
          "type": "string"
9
        },
10
        "Password": {
11
          "type": "null"
12
        },
13
        "FirstName": {
14
          "type": "string"
15
        },
16
        "LastName": {
17
          "type": "string"
18
        },
19
        "DefaultTimeZone": {
20
          "type": "string"
21
        },
22
        "Email": {
23
          "type": "string"
24
        },
25
        "Enabled": {
26
          "type": "boolean"
27
        },
28
        "Locked": {
29
          "type": "boolean"
30
        },
31
        "External": {
32
          "type": "boolean"
33
        },
34
        "Clients": {
35
          "type": "array",
36
          "items": [
37
            {
38
              "type": "object",
39
              "properties": {
40
                "Roles": {
41
                  "type": "array",
42
                  "items": [
43
                    {
44
                      "type": "object",
45
                      "properties": {
46
                        "RoleId": {
47
                          "type": "string"
48
                        },
49
                        "RoleName": {
50
                          "type": "string"
51
                        }
52
                      },
53
                      "required": [
54
                        "RoleId",
55
                        "RoleName"
56
                      ]
57
                    }
58
                  ]
59
                },
60
                "NotInRoles": {
61
                  "type": "array",
62
                  "items": [
63
                    {
64
                      "type": "object",
65
                      "properties": {
66
                        "RoleId": {
67
                          "type": "string"
68
                        },
69
                        "RoleName": {
70
                          "type": "string"
71
                        }
72
                      },
73
                      "required": [
74
                        "RoleId",
75
                        "RoleName"
76
                      ]
77
                    }
78
                  ]
79
                },
80
                "Groups": {
81
                  "type": "array",
82
                  "items": {}
83
                },
84
                "ClientInfo": {
85
                  "type": "object",
86
                  "properties": {
87
                    "ClientId": {
88
                      "type": "string"
89
                    },
90
                    "ClientName": {
91
                      "type": "string"
92
                    }
93
                  },
94
                  "required": [
95
                    "ClientId",
96
                    "ClientName"
97
                  ]
98
                }
99
              },
100
              "required": [
101
                "Roles",
102
                "NotInRoles",
103
                "Groups",
104
                "ClientInfo"
105
              ]
106
            }
107
          ]
108
        },
109
        "UserId": {
110
          "type": "string"
111
        }
112
      },
113
      "required": [
114
        "UserName",
115
        "Password",
116
        "FirstName",
117
        "LastName",
118
        "DefaultTimeZone",
119
        "Email",
120
        "Enabled",
121
        "Locked",
122
        "External",
123
        "Clients",
124
        "UserId"
125
      ]
126
    },
127
    "IsSuccess": {
128
      "type": "boolean"
129
    },
130
    "Reason": {
131
      "type": "null"
132
    },
133
    "ErrorMessage": {
134
      "type": "null"
135
    },
136
    "Links": {
137
      "type": "array",
138
      "items": [
139
        {
140
          "type": "object",
141
          "properties": {
142
            "Rel": {
143
              "type": "string"
144
            },
145
            "Href": {
146
              "type": "string"
147
            }
148
          },
149
          "required": [
150
            "Rel",
151
            "Href"
152
          ]
153
        }
154
      ]
155
    }
156
  },
157
  "required": [
158
    "Account",
159
    "IsSuccess",
160
    "Reason",
161
    "ErrorMessage",
162
    "Links"
163
  ]
164
}
post

/AppSpiderEnterprise/rest/v1/Account/AddAccount

Description

Add a new user account.

Parameters

Name

Type

Required

Description

Username

string

Y

username

Password

string

Y

password ( this is encrypted on server)

FirstName

string

N

firstname

LastName

string

N

lastName

DefaultTimeZone

string

N

default time zone

Email

string

N

email

Enabled

booelan

Y

enable (true / false)

Locked

booelan

Y

locked (true / false)

External

booelan

Y

External (true / false)

Clients

array

Y

list of user's clients (role,groups,notinroles)

Role

array

Y

client roles

RoleId

guid

Y

role id

RoleName

string

Y

role name

NotInRoles

array

Y

client's not in roles

RoleId

guid

N

role id

RoleName

string

N

role name

Groups

array

Y

client's groups

GroupId

guid

N

group id

GroupName

string

N

group name

ClientInfo

object

Y

Account client

ClientId

guid

Y

client id

ClientName

string

Y

client name

Request example:

JSON schema:
1
{ 
2
  "type": "object",
3
  "properties": {
4
    "Username": {
5
      "type": "string"
6
    },
7
    "Password": {
8
      "type": "string"
9
    },
10
    "FirstName": {
11
      "type": "string"
12
    },
13
    "LastName": {
14
      "type": "string"
15
    },
16
    "DefaultTimeZone": {
17
      "type": "string"
18
    },
19
    "Email": {
20
      "type": "string"
21
    },
22
    "Enabled": {
23
      "type": "boolean"
24
    },
25
    "Locked": {
26
      "type": "boolean"
27
    },
28
    "External": {
29
      "type": "boolean"
30
    },
31
    "Clients": {
32
      "type": "array",
33
      "items": [
34
        {
35
          "type": "object",
36
          "properties": {
37
            "Roles": {
38
              "type": "array",
39
              "items": [
40
                {
41
                  "type": "object",
42
                  "properties": {
43
                    "RoleId": {
44
                      "type": "string"
45
                    },
46
                    "RoleName": {
47
                      "type": "string"
48
                    }
49
                  },
50
                  "required": [
51
                    "RoleId",
52
                    "RoleName"
53
                  ]
54
                }
55
              ]
56
            },
57
            "NotInRoles": {
58
              "type": "array",
59
              "items": [
60
                {
61
                  "type": "object",
62
                  "properties": {
63
                    "RoleId": {
64
                      "type": "string"
65
                    },
66
                    "RoleName": {
67
                      "type": "string"
68
                    }
69
                  },
70
                  "required": [
71
                    "RoleId",
72
                    "RoleName"
73
                  ]
74
                }
75
              ]
76
            },
77
            "Groups": {
78
              "type": "array",
79
              "items": {}
80
            },
81
            "ClientInfo": {
82
              "type": "object",
83
              "properties": {
84
                "ClientId": {
85
                  "type": "string"
86
                },
87
                "ClientName": {
88
                  "type": "string"
89
                }
90
              },
91
              "required": [
92
                "ClientId",
93
                "ClientName"
94
              ]
95
            }
96
          },
97
          "required": [
98
            "Roles",
99
            "NotInRoles",
100
            "Groups",
101
            "ClientInfo"
102
          ]
103
        }
104
      ]
105
    }
106
  },
107
  "required": [
108
    "Username",
109
    "Password",
110
    "FirstName",
111
    "LastName",
112
    "DefaultTimeZone",
113
    "Email",
114
    "Enabled",
115
    "Locked",
116
    "External",
117
    "Clients"
118
  ]
119
}

Response Messages

Response Status Code

Reason

Description

200

Success

account added

400

Failure

Required parameters not provided

Response example:

JSON schema:
1
{ 
2
  "type": "object",
3
  "properties": {
4
    "Account": {
5
      "type": "object",
6
      "properties": {
7
        "UserId": {
8
          "type": "string"
9
        }
10
      },
11
      "required": [
12
        "UserId"
13
      ]
14
    },
15
    "IsSuccess": {
16
      "type": "boolean"
17
    },
18
    "Reason": {
19
      "type": "null"
20
    },
21
    "ErrorMessage": {
22
      "type": "string"
23
    },
24
    "Links": {
25
      "type": "array",
26
      "items": [
27
        {
28
          "type": "object",
29
          "properties": {
30
            "Rel": {
31
              "type": "string"
32
            },
33
            "Href": {
34
              "type": "string"
35
            }
36
          },
37
          "required": [
38
            "Rel",
39
            "Href"
40
          ]
41
        }
42
      ]
43
    }
44
  },
45
  "required": [
46
    "Account",
47
    "IsSuccess",
48
    "Reason",
49
    "ErrorMessage",
50
    "Links"
51
  ]
52
}
put

/AppSpiderEnterprise/rest/v1/Account/UpdateAccount?accountId=<accountid></accountid>

Description

Update a new user account.

Parameters

Name

Type

Required

Description

Username

string

Y

username

Password

string

Y

password ( this is encrypted on server)

FirstName

string

N

firstname

LastName

string

N

lastName

DefaultTimeZone

string

N

default time zone

Email

string

N

email

Enabled

booelan

Y

enable (true / false)

Locked

booelan

Y

locked (true / false)

External

booelan

Y

External (true / false)

Clients

array

Y

list of user's clients (role,groups,notinroles)

Role

array

Y

client roles

RoleId

guid

Y

role id

RoleName

string

Y

role name

NotInRoles

array

Y

client's not in roles

RoleId

guid

N

role id

RoleName

string

N

role name

Groups

array

Y

client's groups

GroupId

guid

N

group id

GroupName

string

N

group name

ClientInfo

object

Y

Account client

ClientId

guid

Y

client id

ClientName

string

Y

client name

Request example:

JSON schema:
1
{ 
2
  "type": "object",
3
  "properties": {
4
    "Username": {
5
      "type": "string"
6
    },
7
    "Password": {
8
      "type": "string"
9
    },
10
    "FirstName": {
11
      "type": "string"
12
    },
13
    "LastName": {
14
      "type": "string"
15
    },
16
    "DefaultTimeZone": {
17
      "type": "string"
18
    },
19
    "Email": {
20
      "type": "string"
21
    },
22
    "Enabled": {
23
      "type": "boolean"
24
    },
25
    "Locked": {
26
      "type": "boolean"
27
    },
28
    "External": {
29
      "type": "boolean"
30
    },
31
    "Clients": {
32
      "type": "array",
33
      "items": [
34
        {
35
          "type": "object",
36
          "properties": {
37
            "Roles": {
38
              "type": "array",
39
              "items": [
40
                {
41
                  "type": "object",
42
                  "properties": {
43
                    "RoleId": {
44
                      "type": "string"
45
                    },
46
                    "RoleName": {
47
                      "type": "string"
48
                    }
49
                  },
50
                  "required": [
51
                    "RoleId",
52
                    "RoleName"
53
                  ]
54
                }
55
              ]
56
            },
57
            "NotInRoles": {
58
              "type": "array",
59
              "items": [
60
                {
61
                  "type": "object",
62
                  "properties": {
63
                    "RoleId": {
64
                      "type": "string"
65
                    },
66
                    "RoleName": {
67
                      "type": "string"
68
                    }
69
                  },
70
                  "required": [
71
                    "RoleId",
72
                    "RoleName"
73
                  ]
74
                }
75
              ]
76
            },
77
            "Groups": {
78
              "type": "array",
79
              "items": {}
80
            },
81
            "ClientInfo": {
82
              "type": "object",
83
              "properties": {
84
                "ClientId": {
85
                  "type": "string"
86
                },
87
                "ClientName": {
88
                  "type": "string"
89
                }
90
              },
91
              "required": [
92
                "ClientId",
93
                "ClientName"
94
              ]
95
            }
96
          },
97
          "required": [
98
            "Roles",
99
            "NotInRoles",
100
            "Groups",
101
            "ClientInfo"
102
          ]
103
        }
104
      ]
105
    }
106
  },
107
  "required": [
108
    "Username",
109
    "Password",
110
    "FirstName",
111
    "LastName",
112
    "DefaultTimeZone",
113
    "Email",
114
    "Enabled",
115
    "Locked",
116
    "External",
117
    "Clients"
118
  ]
119
}

Response Messages

Response Status Code

Reason

Description

200

Success

account updated

400

Failure

Required parameters not provided

Response example:

JSON schema:
1
{ 
2
  "type": "object",
3
  "properties": {
4
    "Account": {
5
      "type": "object",
6
      "properties": {
7
        "UserId": {
8
          "type": "string"
9
        }
10
      },
11
      "required": [
12
        "UserId"
13
      ]
14
    },
15
    "IsSuccess": {
16
      "type": "boolean"
17
    },
18
    "Reason": {
19
      "type": "null"
20
    },
21
    "ErrorMessage": {
22
      "type": "string"
23
    },
24
    "Links": {
25
      "type": "array",
26
      "items": [
27
        {
28
          "type": "object",
29
          "properties": {
30
            "Rel": {
31
              "type": "string"
32
            },
33
            "Href": {
34
              "type": "string"
35
            }
36
          },
37
          "required": [
38
            "Rel",
39
            "Href"
40
          ]
41
        }
42
      ]
43
    }
44
  },
45
  "required": [
46
    "Account",
47
    "IsSuccess",
48
    "Reason",
49
    "ErrorMessage",
50
    "Links"
51
  ]
52
}
delete

/AppSpiderEnterprise/rest/v1/Group/DeleteAccount?accountId=<accountid></accountid>

Description

Deletes a user.

Parameters

No parameters

Response Messages

Response Status Code

Reason

Description

200

Success

User has been deleted

Response example:

JSON schema:
1
{
2
  "type": "object",
3
  "properties": {
4
    "IsSuccess": {
5
      "type": "boolean"
6
    },
7
    "Reason": {
8
      "type": "null"
9
    },
10
    "ErrorMessage": {
11
      "type": "null"
12
    },
13
    "Links": {
14
      "type": "array",
15
      "items": [
16
        {
17
          "type": "object",
18
          "properties": {
19
            "Rel": {
20
              "type": "string"
21
            },
22
            "Href": {
23
              "type": "string"
24
            }
25
          },
26
          "required": [
27
            "Rel",
28
            "Href"
29
          ]
30
        }
31
      ]
32
    }
33
  },
34
  "required": [
35
    "IsSuccess",
36
    "Reason",
37
    "ErrorMessage",
38
    "Links"
39
  ]
40
}
get

/AppSpiderEnterprise/rest/v1/Account/GetClients?accountId=<accountid></accountid>

Description

Retrieves all clients accounts Client Admin will only see the client they are associated with or authenticated to System Admins will see all user's clients

Parameters

Name

Type

Required

Description

accountId

guid

Y

request parameter id of the account

Response Messages

Response Status Code

Reason

Description

200

Success

Response contains the account client(s) info

400

Failure

No client info found

Response example:

JSON schema:
1
{
2
  "type": "object",
3
  "properties": {
4
    "Account": {
5
      "type": "object",
6
      "properties": {
7
        "Clients": {
8
          "type": "array",
9
          "items": [
10
            {
11
              "type": "object",
12
              "properties": {
13
                "Roles": {
14
                  "type": "array",
15
                  "items": [
16
                    {
17
                      "type": "object",
18
                      "properties": {
19
                        "RoleId": {
20
                          "type": "string"
21
                        },
22
                        "RoleName": {
23
                          "type": "string"
24
                        }
25
                      },
26
                      "required": [
27
                        "RoleId",
28
                        "RoleName"
29
                      ]
30
                    }
31
                  ]
32
                },
33
                "NotInRoles": {
34
                  "type": "array",
35
                  "items": [
36
                    {
37
                      "type": "object",
38
                      "properties": {
39
                        "RoleId": {
40
                          "type": "string"
41
                        },
42
                        "RoleName": {
43
                          "type": "string"
44
                        }
45
                      },
46
                      "required": [
47
                        "RoleId",
48
                        "RoleName"
49
                      ]
50
                    }
51
                  ]
52
                },
53
                "Groups": {
54
                  "type": "array",
55
                  "items": [
56
                    {
57
                      "type": "object",
58
                      "properties": {
59
                        "GroupId": {
60
                          "type": "string"
61
                        },
62
                        "GroupName": {
63
                          "type": "string"
64
                        }
65
                      },
66
                      "required": [
67
                        "GroupId",
68
                        "GroupName"
69
                      ]
70
                    }
71
                  ]
72
                },
73
                "ClientInfo": {
74
                  "type": "object",
75
                  "properties": {
76
                    "ClientId": {
77
                      "type": "string"
78
                    },
79
                    "ClientName": {
80
                      "type": "string"
81
                    }
82
                  },
83
                  "required": [
84
                    "ClientId",
85
                    "ClientName"
86
                  ]
87
                }
88
              },
89
              "required": [
90
                "Roles",
91
                "NotInRoles",
92
                "Groups",
93
                "ClientInfo"
94
              ]
95
            },
96
            {
97
              "type": "object",
98
              "properties": {
99
                "Roles": {
100
                  "type": "array",
101
                  "items": [
102
                    {
103
                      "type": "object",
104
                      "properties": {
105
                        "RoleId": {
106
                          "type": "string"
107
                        },
108
                        "RoleName": {
109
                          "type": "string"
110
                        }
111
                      },
112
                      "required": [
113
                        "RoleId",
114
                        "RoleName"
115
                      ]
116
                    }
117
                  ]
118
                },
119
                "NotInRoles": {
120
                  "type": "array",
121
                  "items": [
122
                    {
123
                      "type": "object",
124
                      "properties": {
125
                        "RoleId": {
126
                          "type": "string"
127
                        },
128
                        "RoleName": {
129
                          "type": "string"
130
                        }
131
                      },
132
                      "required": [
133
                        "RoleId",
134
                        "RoleName"
135
                      ]
136
                    }
137
                  ]
138
                },
139
                "Groups": {
140
                  "type": "array",
141
                  "items": {}
142
                },
143
                "ClientInfo": {
144
                  "type": "object",
145
                  "properties": {
146
                    "ClientId": {
147
                      "type": "string"
148
                    },
149
                    "ClientName": {
150
                      "type": "string"
151
                    }
152
                  },
153
                  "required": [
154
                    "ClientId",
155
                    "ClientName"
156
                  ]
157
                }
158
              },
159
              "required": [
160
                "Roles",
161
                "NotInRoles",
162
                "Groups",
163
                "ClientInfo"
164
              ]
165
            }
166
          ]
167
        },
168
        "UserId": {
169
          "type": "string"
170
        }
171
      },
172
      "required": [
173
        "Clients",
174
        "UserId"
175
      ]
176
    },
177
    "IsSuccess": {
178
      "type": "boolean"
179
    },
180
    "Reason": {
181
      "type": "null"
182
    },
183
    "ErrorMessage": {
184
      "type": "null"
185
    },
186
    "Links": {
187
      "type": "array",
188
      "items": [
189
        {
190
          "type": "object",
191
          "properties": {
192
            "Rel": {
193
              "type": "string"
194
            },
195
            "Href": {
196
              "type": "string"
197
            }
198
          },
199
          "required": [
200
            "Rel",
201
            "Href"
202
          ]
203
        }
204
      ]
205
    }
206
  },
207
  "required": [
208
    "Account",
209
    "IsSuccess",
210
    "Reason",
211
    "ErrorMessage",
212
    "Links"
213
  ]
214
}
post

/AppSpiderEnterprise/rest/v1/Account/AddClients?accountId=<accountid></accountid>

Description

Add a new client to a user account. Sys admin only

Parameters

Name

Type

Required

Description

Clients

array

Y

list of user's clients (role,groups,notinroles)

Role

array

Y

client roles

RoleId

guid

Y

role id

RoleName

string

Y

role name

NotInRoles

array

Y

client's not in roles

RoleId

guid

N

role id

RoleName

string

N

role name

Groups

array

Y

client's groups

GroupId

guid

N

group id

GroupName

string

N

group name

ClientInfo

object

Y

Account client

ClientId

guid

Y

client id

ClientName

string

Y

client name

Request example:

JSON schema:
1
{
2
  "type": "object",
3
  "properties": {
4
    "Clients": {
5
      "type": "array",
6
      "items": [
7
        {
8
          "type": "object",
9
          "properties": {
10
            "Roles": {
11
              "type": "array",
12
              "items": [
13
                {
14
                  "type": "object",
15
                  "properties": {
16
                    "RoleId": {
17
                      "type": "string"
18
                    },
19
                    "RoleName": {
20
                      "type": "string"
21
                    }
22
                  },
23
                  "required": [
24
                    "RoleId",
25
                    "RoleName"
26
                  ]
27
                }
28
              ]
29
            },
30
            "NotInRoles": {
31
              "type": "array",
32
              "items": [
33
                {
34
                  "type": "object",
35
                  "properties": {
36
                    "RoleId": {
37
                      "type": "string"
38
                    },
39
                    "RoleName": {
40
                      "type": "string"
41
                    }
42
                  },
43
                  "required": [
44
                    "RoleId",
45
                    "RoleName"
46
                  ]
47
                }
48
              ]
49
            },
50
            "Groups": {
51
              "type": "array",
52
              "items": [
53
                {
54
                  "type": "object",
55
                  "properties": {
56
                    "GroupId": {
57
                      "type": "string"
58
                    },
59
                    "GroupName": {
60
                      "type": "string"
61
                    }
62
                  },
63
                  "required": [
64
                    "GroupId",
65
                    "GroupName"
66
                  ]
67
                }
68
              ]
69
            },
70
            "ClientInfo": {
71
              "type": "object",
72
              "properties": {
73
                "ClientId": {
74
                  "type": "string"
75
                },
76
                "ClientName": {
77
                  "type": "string"
78
                }
79
              },
80
              "required": [
81
                "ClientId",
82
                "ClientName"
83
              ]
84
            }
85
          },
86
          "required": [
87
            "Roles",
88
            "NotInRoles",
89
            "Groups",
90
            "ClientInfo"
91
          ]
92
        }
93
      ]
94
    }
95
  },
96
  "required": [
97
    "Clients"
98
  ]
99
}

Response Messages

Response Status Code

Reason

Description

200

Success

account client(s) added

400

Failure

Required parameters not provided

Response example:

JSON schema:
1
{ 
2
  "type": "object",
3
  "properties": {
4
    "Account": {
5
      "type": "object",
6
      "properties": {
7
        "UserId": {
8
          "type": "string"
9
        }
10
      },
11
      "required": [
12
        "UserId"
13
      ]
14
    },
15
    "IsSuccess": {
16
      "type": "boolean"
17
    },
18
    "Reason": {
19
      "type": "null"
20
    },
21
    "ErrorMessage": {
22
      "type": "null"
23
    },
24
    "Links": {
25
      "type": "array",
26
      "items": [
27
        {
28
          "type": "object",
29
          "properties": {
30
            "Rel": {
31
              "type": "string"
32
            },
33
            "Href": {
34
              "type": "string"
35
            }
36
          },
37
          "required": [
38
            "Rel",
39
            "Href"
40
          ]
41
        }
42
      ]
43
    }
44
  },
45
  "required": [
46
    "Account",
47
    "IsSuccess",
48
    "Reason",
49
    "ErrorMessage",
50
    "Links"
51
  ]
52
}
53
put

/AppSpiderEnterprise/rest/v1/Account/UpdateClients?accountId=<accountid></accountid>

Description

Updates a user's client(s)

Parameters

Name

Type

Required

Description

Clients

array

Y

list of user's clients (role,groups,notinroles)

Role

array

Y

client roles

RoleId

guid

Y

role id

RoleName

string

Y

role name

NotInRoles

array

Y

client's not in roles

RoleId

guid

N

role id

RoleName

string

N

role name

Groups

array

Y

client's groups

GroupId

guid

N

group id

GroupName

string

N

group name

ClientInfo

object

Y

Account client

ClientId

guid

Y

client id

ClientName

string

Y

client name

Request example:

JSON schema:
1
{
2
  "type": "object",
3
  "properties": {
4
    "Clients": {
5
      "type": "array",
6
      "items": [
7
        {
8
          "type": "object",
9
          "properties": {
10
            "Roles": {
11
              "type": "array",
12
              "items": [
13
                {
14
                  "type": "object",
15
                  "properties": {
16
                    "RoleId": {
17
                      "type": "string"
18
                    },
19
                    "RoleName": {
20
                      "type": "string"
21
                    }
22
                  },
23
                  "required": [
24
                    "RoleId",
25
                    "RoleName"
26
                  ]
27
                }
28
              ]
29
            },
30
            "NotInRoles": {
31
              "type": "array",
32
              "items": [
33
                {
34
                  "type": "object",
35
                  "properties": {
36
                    "RoleId": {
37
                      "type": "string"
38
                    },
39
                    "RoleName": {
40
                      "type": "string"
41
                    }
42
                  },
43
                  "required": [
44
                    "RoleId",
45
                    "RoleName"
46
                  ]
47
                }
48
              ]
49
            },
50
            "Groups": {
51
              "type": "array",
52
              "items": [
53
                {
54
                  "type": "object",
55
                  "properties": {
56
                    "GroupId": {
57
                      "type": "string"
58
                    },
59
                    "GroupName": {
60
                      "type": "string"
61
                    }
62
                  },
63
                  "required": [
64
                    "GroupId",
65
                    "GroupName"
66
                  ]
67
                }
68
              ]
69
            },
70
            "ClientInfo": {
71
              "type": "object",
72
              "properties": {
73
                "ClientId": {
74
                  "type": "string"
75
                },
76
                "ClientName": {
77
                  "type": "string"
78
                }
79
              },
80
              "required": [
81
                "ClientId",
82
                "ClientName"
83
              ]
84
            }
85
          },
86
          "required": [
87
            "Roles",
88
            "NotInRoles",
89
            "Groups",
90
            "ClientInfo"
91
          ]
92
        }
93
      ]
94
    }
95
  },
96
  "required": [
97
    "Clients"
98
  ]
99
}

Response Messages

Response Status Code

Reason

Description

200

Success

account client(s) uddated

400

Failure

Required parameters not provided

Response example:

JSON schema:
1
{ 
2
  "type": "object",
3
  "properties": {
4
    "Account": {
5
      "type": "object",
6
      "properties": {
7
        "UserId": {
8
          "type": "string"
9
        }
10
      },
11
      "required": [
12
        "UserId"
13
      ]
14
    },
15
    "IsSuccess": {
16
      "type": "boolean"
17
    },
18
    "Reason": {
19
      "type": "null"
20
    },
21
    "ErrorMessage": {
22
      "type": "null"
23
    },
24
    "Links": {
25
      "type": "array",
26
      "items": [
27
        {
28
          "type": "object",
29
          "properties": {
30
            "Rel": {
31
              "type": "string"
32
            },
33
            "Href": {
34
              "type": "string"
35
            }
36
          },
37
          "required": [
38
            "Rel",
39
            "Href"
40
          ]
41
        }
42
      ]
43
    }
44
  },
45
  "required": [
46
    "Account",
47
    "IsSuccess",
48
    "Reason",
49
    "ErrorMessage",
50
    "Links"
51
  ]
52
}
53
delete

/AppSpiderEnterprise/rest/v1/Group/DeleteClients?accountId=<accountid></accountid>

Description

Deletes a user's client(s) Sys admin only

Parameters

Name

Type

Required

Description

accountId

guid

Y

request parameter id of the account to return

ClientId

string

Y

Client Id

ClientName

string

Y

Client Name

Response Messages

Response Status Code

Reason

Description

200

Success

User's client(s) has been deleted

Request example:

JSON schema:
1
{ 
2
  "type": "array",
3
  "items": [
4
    {
5
      "type": "object",
6
      "properties": {
7
        "ClientId": {
8
          "type": "string"
9
        },
10
        "ClientName": {
11
          "type": "string"
12
        }
13
      },
14
      "required": [
15
        "ClientId",
16
        "ClientName"
17
      ]
18
    },
19
    {
20
      "type": "object",
21
      "properties": {
22
        "ClientId": {
23
          "type": "string"
24
        },
25
        "ClientName": {
26
          "type": "string"
27
        }
28
      },
29
      "required": [
30
        "ClientId",
31
        "ClientName"
32
      ]
33
    }
34
  ]
35
}

Response example:

JSON schema:
1
{
2
  "type": "object",
3
  "properties": {
4
    "IsSuccess": {
5
      "type": "boolean"
6
    },
7
    "Reason": {
8
      "type": "null"
9
    },
10
    "ErrorMessage": {
11
      "type": "null"
12
    },
13
    "Links": {
14
      "type": "array",
15
      "items": [
16
        {
17
          "type": "object",
18
          "properties": {
19
            "Rel": {
20
              "type": "string"
21
            },
22
            "Href": {
23
              "type": "string"
24
            }
25
          },
26
          "required": [
27
            "Rel",
28
            "Href"
29
          ]
30
        }
31
      ]
32
    }
33
  },
34
  "required": [
35
    "IsSuccess",
36
    "Reason",
37
    "ErrorMessage",
38
    "Links"
39
  ]
40
}