REST API for Unified Assurance Core

Update a Role

put

/api/AAA/Roles/{id}

Updates the properties of the role that matches the specified ID.

Request

Path Parameters

id(required): integer(int32)
The role ID.
Example:
```
1
```

Supported Media Types

application/json

Root Schema : schema

Type: object

Details of the role to create or update.

Show Source

Description: string

The description of the role.

Example: Administrators have complete access to all user interfaces
Permissions: array Permissions

The permissions associated with the role. The <operation>Available properties determine whether it is possible to grant a permission and the <operation>Flag properties determine whether the permission is granted.
RoleName: string

The role name.

Example: Administrator

{
    "properties":{
        "RoleName":{
            "description":"The role name.",
            "type":"string",
            "example":"Administrator"
        },
        "Description":{
            "description":"The description of the role.",
            "type":"string",
            "example":"Administrators have complete access to all user interfaces"
        },
        "Permissions":{
            "description":"The permissions associated with the role. The <i>&lt;operation&gt;</i><b>Available</b> properties determine whether it is possible to grant a permission and the <i>&lt;operation&gt;</i><b>Flag</b> properties determine whether the permission is granted.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "PermissionID":{
                        "description":"The permission ID.",
                        "type":"integer",
                        "example":"10001"
                    },
                    "PermissionName":{
                        "description":"The permission name.",
                        "type":"string",
                        "example":"SUPER"
                    },
                    "PackageName":{
                        "description":"The package name.",
                        "type":"string",
                        "example":"global"
                    },
                    "ReadAvailable":{
                        "description":"Whether the Read operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "CreateAvailable":{
                        "description":"Whether the Create operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "UpdateAvailable":{
                        "description":"Whether the Update operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "DeleteAvailable":{
                        "description":"Whether the Delete operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "ExecuteAvailable":{
                        "description":"Whether the Execute operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "Description":{
                        "description":"The description of the permission.",
                        "type":"string",
                        "example":"Assigns administrative rights to view and modify items even if not the owner"
                    },
                    "ReadFlag":{
                        "description":"Whether the role has Read access for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "CreateFlag":{
                        "description":"Whether the role has Create access for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "UpdateFlag":{
                        "description":"Whether the role has Update access for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "DeleteFlag":{
                        "description":"Whether the role has Delete access for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "ExecuteFlag":{
                        "description":"Whether the role has Execute access for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    }
                }
            }
        }
    },
    "type":"object",
    "description":"Details of the role to create or update."
}

Nested Schema : Permissions

Type: array

The permissions associated with the role. The <operation>Available properties determine whether it is possible to grant a permission and the <operation>Flag properties determine whether the permission is granted.

Show Source

Array of: object items

{
    "description":"The permissions associated with the role. The <i>&lt;operation&gt;</i><b>Available</b> properties determine whether it is possible to grant a permission and the <i>&lt;operation&gt;</i><b>Flag</b> properties determine whether the permission is granted.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "PermissionID":{
                "description":"The permission ID.",
                "type":"integer",
                "example":"10001"
            },
            "PermissionName":{
                "description":"The permission name.",
                "type":"string",
                "example":"SUPER"
            },
            "PackageName":{
                "description":"The package name.",
                "type":"string",
                "example":"global"
            },
            "ReadAvailable":{
                "description":"Whether the Read operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "CreateAvailable":{
                "description":"Whether the Create operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "UpdateAvailable":{
                "description":"Whether the Update operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "DeleteAvailable":{
                "description":"Whether the Delete operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "ExecuteAvailable":{
                "description":"Whether the Execute operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "Description":{
                "description":"The description of the permission.",
                "type":"string",
                "example":"Assigns administrative rights to view and modify items even if not the owner"
            },
            "ReadFlag":{
                "description":"Whether the role has Read access for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "CreateFlag":{
                "description":"Whether the role has Create access for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "UpdateFlag":{
                "description":"Whether the role has Update access for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "DeleteFlag":{
                "description":"Whether the role has Delete access for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "ExecuteFlag":{
                "description":"Whether the role has Execute access for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

CreateAvailable: integer

Whether the Create operation is available for the permission (1) or not (0).

Example: 0
CreateFlag: integer

Whether the role has Create access for the permission (1) or not (0).

Example: 0
DeleteAvailable: integer

Whether the Delete operation is available for the permission (1) or not (0).

Example: 0
DeleteFlag: integer

Whether the role has Delete access for the permission (1) or not (0).

Example: 0
Description: string

The description of the permission.

Example: Assigns administrative rights to view and modify items even if not the owner
ExecuteAvailable: integer

Whether the Execute operation is available for the permission (1) or not (0).

Example: 0
ExecuteFlag: integer

Whether the role has Execute access for the permission (1) or not (0).

Example: 0
PackageName: string

The package name.

Example: global
PermissionID: integer

The permission ID.

Example: 10001
PermissionName: string

The permission name.

Example: SUPER
ReadAvailable: integer

Whether the Read operation is available for the permission (1) or not (0).

Example: 0
ReadFlag: integer

Whether the role has Read access for the permission (1) or not (0).

Example: 0
UpdateAvailable: integer

Whether the Update operation is available for the permission (1) or not (0).

Example: 0
UpdateFlag: integer

Whether the role has Update access for the permission (1) or not (0).

Example: 0

{
    "type":"object",
    "properties":{
        "PermissionID":{
            "description":"The permission ID.",
            "type":"integer",
            "example":"10001"
        },
        "PermissionName":{
            "description":"The permission name.",
            "type":"string",
            "example":"SUPER"
        },
        "PackageName":{
            "description":"The package name.",
            "type":"string",
            "example":"global"
        },
        "ReadAvailable":{
            "description":"Whether the Read operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "CreateAvailable":{
            "description":"Whether the Create operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "UpdateAvailable":{
            "description":"Whether the Update operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "DeleteAvailable":{
            "description":"Whether the Delete operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "ExecuteAvailable":{
            "description":"Whether the Execute operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "Description":{
            "description":"The description of the permission.",
            "type":"string",
            "example":"Assigns administrative rights to view and modify items even if not the owner"
        },
        "ReadFlag":{
            "description":"Whether the role has Read access for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "CreateFlag":{
            "description":"Whether the role has Create access for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "UpdateFlag":{
            "description":"Whether the role has Update access for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "DeleteFlag":{
            "description":"Whether the role has Delete access for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "ExecuteFlag":{
            "description":"Whether the role has Execute access for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Match All

Show Source

object SuccessfulUpdateOperation

The response body for a successful update operation.
object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulUpdateOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/AAARolesRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulUpdateOperation

Type: object

The response body for a successful update operation.

Show Source

message: string

The response message.

Example: Updated record
success: boolean

Whether the operation was a success (true) or a failure (false).

Example: true

{
    "description":"The response body for a successful update operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Updated record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

data: array data
total: integer

The total number of results regardless of paging.

Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AAARolesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object AAARolesRead

Role details.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AAARolesRead"
    }
}

Nested Schema : AAARolesRead

Type: object

Role details.

Show Source

Description: string

The description of the role.

Example: Administrators have complete access to all user interfaces
Permissions: array Permissions

The permissions associated with the role. The <Operation>Available properties determine whether it is possible to enable an operation for the permission and the <operation>Flag properties determine whether the operation is enabled.
RoleID: integer

The role ID.

Example: 1
RoleName: string

The role name.

Example: Administrator

{
    "properties":{
        "RoleID":{
            "description":"The role ID.",
            "type":"integer",
            "example":"1"
        },
        "RoleName":{
            "description":"The role name.",
            "type":"string",
            "example":"Administrator"
        },
        "Description":{
            "description":"The description of the role.",
            "type":"string",
            "example":"Administrators have complete access to all user interfaces"
        },
        "Permissions":{
            "description":"The permissions associated with the role. The <i>&lt;Operation&gt;</i><b>Available</b> properties determine whether it is possible to enable an operation for the permission and the <i>&lt;operation&gt;</i><b>Flag</b> properties determine whether the operation is enabled.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "PermissionID":{
                        "description":"The permission ID.",
                        "type":"integer",
                        "example":"10001"
                    },
                    "PermissionName":{
                        "description":"The permission name.",
                        "type":"string",
                        "example":"SUPER"
                    },
                    "PackageName":{
                        "description":"The package name.",
                        "type":"string",
                        "example":"global"
                    },
                    "ReadAvailable":{
                        "description":"Whether the Read operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "CreateAvailable":{
                        "description":"Whether the Create operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "UpdateAvailable":{
                        "description":"Whether the Update operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "DeleteAvailable":{
                        "description":"Whether the Delete operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "ExecuteAvailable":{
                        "description":"Whether the Execute operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "Description":{
                        "description":"The description of the permission.",
                        "type":"string",
                        "example":"Assigns administrative rights to view and modify items even if not the owner"
                    },
                    "ReadFlag":{
                        "description":"Whether the role has Read access for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "CreateFlag":{
                        "description":"Whether the role has Create access for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "UpdateFlag":{
                        "description":"Whether the role has Update access for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "DeleteFlag":{
                        "description":"Whether the role has Delete access for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    },
                    "ExecuteFlag":{
                        "description":"Whether the role has Execute access for the permission (<b>1</b>) or not (<b>0</b>).",
                        "type":"integer",
                        "example":"0"
                    }
                }
            }
        }
    },
    "type":"object",
    "description":"Role details."
}

Nested Schema : Permissions

Type: array

The permissions associated with the role. The <Operation>Available properties determine whether it is possible to enable an operation for the permission and the <operation>Flag properties determine whether the operation is enabled.

Show Source

Array of: object items

{
    "description":"The permissions associated with the role. The <i>&lt;Operation&gt;</i><b>Available</b> properties determine whether it is possible to enable an operation for the permission and the <i>&lt;operation&gt;</i><b>Flag</b> properties determine whether the operation is enabled.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "PermissionID":{
                "description":"The permission ID.",
                "type":"integer",
                "example":"10001"
            },
            "PermissionName":{
                "description":"The permission name.",
                "type":"string",
                "example":"SUPER"
            },
            "PackageName":{
                "description":"The package name.",
                "type":"string",
                "example":"global"
            },
            "ReadAvailable":{
                "description":"Whether the Read operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "CreateAvailable":{
                "description":"Whether the Create operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "UpdateAvailable":{
                "description":"Whether the Update operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "DeleteAvailable":{
                "description":"Whether the Delete operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "ExecuteAvailable":{
                "description":"Whether the Execute operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "Description":{
                "description":"The description of the permission.",
                "type":"string",
                "example":"Assigns administrative rights to view and modify items even if not the owner"
            },
            "ReadFlag":{
                "description":"Whether the role has Read access for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "CreateFlag":{
                "description":"Whether the role has Create access for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "UpdateFlag":{
                "description":"Whether the role has Update access for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "DeleteFlag":{
                "description":"Whether the role has Delete access for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            },
            "ExecuteFlag":{
                "description":"Whether the role has Execute access for the permission (<b>1</b>) or not (<b>0</b>).",
                "type":"integer",
                "example":"0"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

CreateAvailable: integer

Whether the Create operation is available for the permission (1) or not (0).

Example: 0
CreateFlag: integer

Whether the role has Create access for the permission (1) or not (0).

Example: 0
DeleteAvailable: integer

Whether the Delete operation is available for the permission (1) or not (0).

Example: 0
DeleteFlag: integer

Whether the role has Delete access for the permission (1) or not (0).

Example: 0
Description: string

The description of the permission.

Example: Assigns administrative rights to view and modify items even if not the owner
ExecuteAvailable: integer

Whether the Execute operation is available for the permission (1) or not (0).

Example: 0
ExecuteFlag: integer

Whether the role has Execute access for the permission (1) or not (0).

Example: 0
PackageName: string

The package name.

Example: global
PermissionID: integer

The permission ID.

Example: 10001
PermissionName: string

The permission name.

Example: SUPER
ReadAvailable: integer

Whether the Read operation is available for the permission (1) or not (0).

Example: 0
ReadFlag: integer

Whether the role has Read access for the permission (1) or not (0).

Example: 0
UpdateAvailable: integer

Whether the Update operation is available for the permission (1) or not (0).

Example: 0
UpdateFlag: integer

Whether the role has Update access for the permission (1) or not (0).

Example: 0

{
    "type":"object",
    "properties":{
        "PermissionID":{
            "description":"The permission ID.",
            "type":"integer",
            "example":"10001"
        },
        "PermissionName":{
            "description":"The permission name.",
            "type":"string",
            "example":"SUPER"
        },
        "PackageName":{
            "description":"The package name.",
            "type":"string",
            "example":"global"
        },
        "ReadAvailable":{
            "description":"Whether the Read operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "CreateAvailable":{
            "description":"Whether the Create operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "UpdateAvailable":{
            "description":"Whether the Update operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "DeleteAvailable":{
            "description":"Whether the Delete operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "ExecuteAvailable":{
            "description":"Whether the Execute operation is available for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "Description":{
            "description":"The description of the permission.",
            "type":"string",
            "example":"Assigns administrative rights to view and modify items even if not the owner"
        },
        "ReadFlag":{
            "description":"Whether the role has Read access for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "CreateFlag":{
            "description":"Whether the role has Create access for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "UpdateFlag":{
            "description":"Whether the role has Update access for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "DeleteFlag":{
            "description":"Whether the role has Delete access for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "ExecuteFlag":{
            "description":"Whether the role has Execute access for the permission (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        }
    }
}

Default Response

Failed operation

Root Schema : schema

Type: object

Show Source

errors: array errors

The list of errors reported. Validation errors will be keyed by record field.
message: string

The response message.

Example: Exception thrown
success: boolean

Whether the operation was a success (true) or a failure (false).

Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

Array of: object items

An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.