System Admin Operations

Credential Warning

Note: Sys Admin required to execute System Admin operations.

/AppSpiderEnterprise/rest/v1/SysAdmin/AddAccount

Description

Adds a sysadmin new account

Parameters

No parameters

Response Messages

Response Status Code

Reason

Description

200

Success

Response contains the accountId

Request Schema

json
1
{
2
  "type": "object",
3
  "properties": {
4
    "UserName": {
5
      "type": "string"
6
    },
7
    "Email": {
8
      "type": "string"
9
    },
10
    "Password": {
11
      "type": "string"
12
    },
13
    "FirstName": {
14
      "type": "string"
15
    },
16
    "LastName": {
17
      "type": "string"
18
    },
19
    "IsApproved": {
20
      "type": "boolean"
21
    }
22
  },
23
  "required": [
24
    "UserName",
25
    "Email",
26
    "Password",
27
    "FirstName",
28
    "LastName",
29
    "IsApproved"
30
  ]
31
}

/AppSpiderEnterprise/rest/v1/SysAdmin/AddExistingAccount?accountId=<account id></account>

Description

Migrates an existing user to a sysadmin role

Parameter

AccountId

Response Messages

Name

Type

Required

Description

AccountId

string

Y

If an existing user accountId is provided that user will migrate to a sysadmin role

Response Code

Reason

Description

200

Success

Response code contains the accountId

Response Schema

json
1
{
2
  "type": "object",
3
  "properties": {
4
    "SystemAdmin": {
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
    "SystemAdmin",
47
    "IsSuccess",
48
    "Reason",
49
    "ErrorMessage",
50
    "Links"
51
  ]
52
}

/AppSpiderEnterprise/rest/v1/SysAdmin/UpdateAccount?userId=<user id></user>

Description

Update an existing sysadmin user

Parameter

AccountId

Response Messages

Response Code

Reason

Description

200

Success

Response code contains the accountId

Name

Type

Required

Decription

UserId

string

Y

The accountId of the user you wish to update

Request Schema

json
1
{
2
  "type": "object",
3
  "properties": {
4
    "UserName": {
5
      "type": "string"
6
    },
7
    "Email": {
8
      "type": "string"
9
    },
10
    "Password": {
11
      "type": "string"
12
    },
13
    "FirstName": {
14
      "type": "string"
15
    },
16
    "LastName": {
17
      "type": "string"
18
    },
19
    "IsApproved": {
20
      "type": "boolean"
21
    }
22
  },
23
  "required": [
24
    "UserName",
25
    "Email",
26
    "Password",
27
    "FirstName",
28
    "LastName",
29
    "IsApproved"
30
  ]
31
}

/AppSpiderEnterprise/rest/v1/SysAdmin/GetAccount?userId=<user id></user>

Description

Get a sysadmin account info

Parameter

AccountId

Response Messages

Response Code

Reason

Description

200

Success

Response code account info

Name

Type

Required

Description

UserId

string

Y

The accountId of the user you wish to retrieve

Response Schema

json
1
{
2
  "type": "object",
3
  "properties": {
4
    "SystemAdmin": {
5
      "type": "object",
6
      "properties": {
7
        "UserName": {
8
          "type": "string"
9
        },
10
        "Email": {
11
          "type": "string"
12
        },
13
        "Password": {
14
          "type": "string"
15
        },
16
        "FirstName": {
17
          "type": "string"
18
        },
19
        "LastName": {
20
          "type": "string"
21
        },
22
        "Enabled": {
23
          "type": "boolean"
24
        },
25
        "UserId": {
26
          "type": "string"
27
        }
28
      },
29
      "required": [
30
        "UserName",
31
        "Email",
32
        "Password",
33
        "FirstName",
34
        "LastName",
35
        "Enabled",
36
        "UserId"
37
      ]
38
    },
39
    "IsSuccess": {
40
      "type": "boolean"
41
    },
42
    "Reason": {
43
      "type": "null"
44
    },
45
    "ErrorMessage": {
46
      "type": "null"
47
    },
48
    "Links": {
49
      "type": "array",
50
      "items": [
51
        {
52
          "type": "object",
53
          "properties": {
54
            "Rel": {
55
              "type": "string"
56
            },
57
            "Href": {
58
              "type": "string"
59
            }
60
          },
61
          "required": [
62
            "Rel",
63
            "Href"
64
          ]
65
        }
66
      ]
67
    }
68
  },
69
  "required": [
70
    "SystemAdmin",
71
    "IsSuccess",
72
    "Reason",
73
    "ErrorMessage",
74
    "Links"
75
  ]
76
}

/AppSpiderEnterprise/rest/v1/SysAdmin/DeleteAccount?userId=<user id></user>

Description

Deletes a sysadmin account

Parameter

AccountId

Response Messages

Name

Type

Required

Description

UserId

string

Y

The accountId of a user you wish to delete

Response Code

Reason

Description

200

Successful

Response containing a success if the account is delete successfully

Response Schema

json
1
{
2
  "type": "object",
3
  "properties": {
4
    "SystemAdmin": {
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
    "SystemAdmin",
47
    "IsSuccess",
48
    "Reason",
49
    "ErrorMessage",
50
    "Links"
51
  ]
52
}