Role Operations

❌

Credential Warning

Note: Sys Admin or Client Admin account permissions required to execute role operations.

get /AppSpiderEnterprise/rest/v1/Role/Roles

Description

Retrieves a list of roles.

Parameters

No parameters

Response Messages

Response Status Code	Reason	Description
200	Success	Response contains the list of roles

Response example


{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "Roles": {
      "type": "array",
      "items": [
        {
          "type": "object",
          "properties": {
            "RoleId": {
              "type": "string"
            },
            "RoleName": {
              "type": "string"
            }
          },
          "required": [
            "RoleId",
            "RoleName"
          ]
        }
      ]
    },
    "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": [
    "Roles",
    "IsSuccess",
    "Reason",
    "ErrorMessage",
    "Links"
  ]
}

get /AppSpiderEnterprise/rest/v1/Role/GetRole?roleName=<insertRoleName>

Description

Retrieves a roles by role name.

Parameters

Name	Type	Required	Description
roleName	string	Y	Role Name

Response Messages

Response Status Code	Reason	Description
200	Success	Response contains role info
400		Required parameters not provided
400	NotFound	No Role Found

Response example


{ 
  "type": "object",
  "properties": {
    "Roles": {
      "type": "array",
      "items": [
        {
          "type": "object",
          "properties": {
            "RoleId": {
              "type": "string"
            },
            "RoleName": {
              "type": "string"
            }
          },
          "required": [
            "RoleId",
            "RoleName"
          ]
        }
      ]
    },
    "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": [
    "Roles",
    "IsSuccess",
    "Reason",
    "ErrorMessage",
    "Links"
  ]
}

get /AppSpiderEnterprise/rest/v1/Role/GetRole?roleId=<insertRoleId>

Description

Retrieves a roles by role id.

Parameters

Name	Type	Required	Description
roleId	guid	Y	Role Id

Response Messages

Response Status Code	Reason	Description
200	Success	Response contains role info
400		Required parameters not provided
400	NotFound	No Role Found

Response example


{ 
  "type": "object",
  "properties": {
    "Roles": {
      "type": "array",
      "items": [
        {
          "type": "object",
          "properties": {
            "RoleId": {
              "type": "string"
            },
            "RoleName": {
              "type": "string"
            }
          },
          "required": [
            "RoleId",
            "RoleName"
          ]
        }
      ]
    },
    "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": [
    "Roles",
    "IsSuccess",
    "Reason",
    "ErrorMessage",
    "Links"
  ]
}