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:

JSON schema:
1
{
2
  "$schema": "http://json-schema.org/draft-04/schema#",
3
  "type": "object",
4
  "properties": {
5
    "Roles": {
6
      "type": "array",
7
      "items": [
8
        {
9
          "type": "object",
10
          "properties": {
11
            "RoleId": {
12
              "type": "string"
13
            },
14
            "RoleName": {
15
              "type": "string"
16
            }
17
          },
18
          "required": [
19
            "RoleId",
20
            "RoleName"
21
          ]
22
        }
23
      ]
24
    },
25
    "IsSuccess": {
26
      "type": "boolean"
27
    },
28
    "Reason": {
29
      "type": "null"
30
    },
31
    "ErrorMessage": {
32
      "type": "null"
33
    },
34
    "Links": {
35
      "type": "array",
36
      "items": [
37
        {
38
          "type": "object",
39
          "properties": {
40
            "Rel": {
41
              "type": "string"
42
            },
43
            "Href": {
44
              "type": "string"
45
            }
46
          },
47
          "required": [
48
            "Rel",
49
            "Href"
50
          ]
51
        }
52
      ]
53
    }
54
  },
55
  "required": [
56
    "Roles",
57
    "IsSuccess",
58
    "Reason",
59
    "ErrorMessage",
60
    "Links"
61
  ]
62
}
get

/AppSpiderEnterprise/rest/v1/Role/GetRole?roleName=<insertrolename></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:

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

/AppSpiderEnterprise/rest/v1/Role/GetRole?roleId=<insertroleid></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:

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