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
{
"type": "object",
"properties": {
"UserName": {
"type": "string"
},
"Email": {
"type": "string"
},
"Password": {
"type": "string"
},
"FirstName": {
"type": "string"
},
"LastName": {
"type": "string"
},
"IsApproved": {
"type": "boolean"
}
},
"required": [
"UserName",
"Email",
"Password",
"FirstName",
"LastName",
"IsApproved"
]
}
/AppSpiderEnterprise/rest/v1/SysAdmin/AddExistingAccount?accountId=<account id>
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
{
"type": "object",
"properties": {
"SystemAdmin": {
"type": "object",
"properties": {
"UserId": {
"type": "string"
}
},
"required": [
"UserId"
]
},
"IsSuccess": {
"type": "boolean"
},
"Reason": {
"type": "null"
},
"ErrorMessage": {
"type": "null"
},
"Links": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"Rel": {
"type": "string"
},
"Href": {
"type": "string"
}
},
"required": [
"Rel",
"Href"
]
}
]
}
},
"required": [
"SystemAdmin",
"IsSuccess",
"Reason",
"ErrorMessage",
"Links"
]
}
/AppSpiderEnterprise/rest/v1/SysAdmin/UpdateAccount?userId=<user id>
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
{
"type": "object",
"properties": {
"UserName": {
"type": "string"
},
"Email": {
"type": "string"
},
"Password": {
"type": "string"
},
"FirstName": {
"type": "string"
},
"LastName": {
"type": "string"
},
"IsApproved": {
"type": "boolean"
}
},
"required": [
"UserName",
"Email",
"Password",
"FirstName",
"LastName",
"IsApproved"
]
}
/AppSpiderEnterprise/rest/v1/SysAdmin/GetAccount?userId=<user id>
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
{
"type": "object",
"properties": {
"SystemAdmin": {
"type": "object",
"properties": {
"UserName": {
"type": "string"
},
"Email": {
"type": "string"
},
"Password": {
"type": "string"
},
"FirstName": {
"type": "string"
},
"LastName": {
"type": "string"
},
"Enabled": {
"type": "boolean"
},
"UserId": {
"type": "string"
}
},
"required": [
"UserName",
"Email",
"Password",
"FirstName",
"LastName",
"Enabled",
"UserId"
]
},
"IsSuccess": {
"type": "boolean"
},
"Reason": {
"type": "null"
},
"ErrorMessage": {
"type": "null"
},
"Links": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"Rel": {
"type": "string"
},
"Href": {
"type": "string"
}
},
"required": [
"Rel",
"Href"
]
}
]
}
},
"required": [
"SystemAdmin",
"IsSuccess",
"Reason",
"ErrorMessage",
"Links"
]
}
/AppSpiderEnterprise/rest/v1/SysAdmin/DeleteAccount?userId=<user id>
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
{
"type": "object",
"properties": {
"SystemAdmin": {
"type": "object",
"properties": {
"UserId": {
"type": "string"
}
},
"required": [
"UserId"
]
},
"IsSuccess": {
"type": "boolean"
},
"Reason": {
"type": "null"
},
"ErrorMessage": {
"type": "null"
},
"Links": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"Rel": {
"type": "string"
},
"Href": {
"type": "string"
}
},
"required": [
"Rel",
"Href"
]
}
]
}
},
"required": [
"SystemAdmin",
"IsSuccess",
"Reason",
"ErrorMessage",
"Links"
]
}