Roles Endpoints (2022/06)

41min

these endpoints allow users to manage roles on a network base url for these endpoints https //api bsn cloud/2022/06/rest/roles get / returns a list of roles on a network required scope token bsn api main roles retrieve query string parameters marker string string optional optional a value specifying which page to retrieve this value is useful if the istruncated entry in the response body of the previous get call indicates that the number of role instances exceeds the pagesize this parameter is only required if you need more elements in the paged list than the pagesize (100) pagesize int int optional optional the maximum number of role instances that can be contained in the response body this defaults to the maximum allowed page size (100) request example the example request parameters and headers are set as follows marker value is set to the \[pagedlist] \[nextmarker] property value from the previous bsn cloud api response pagesize is set to 1 get /2022/06/rest/roles/?marker=4kfak45jfk0915nve\&pagesize=1 http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate s uccess response body 200 200 returns a paged list entity (2022/06) docid\ pwwr0ln3 binngl mr3st of role entity (2022/06) docid\ b3xqot7ihhthnvacb0ngd instances on a network this will return not more than 100 entities along with the information necessary to return any other remaining pages example { "items" \[ { "id" 12345, "iscustom" true, "name" "custom role 20231115", "description" "", "creationdate" "2023 11 15t19 14 10 087z", "usercount" 0, "users" null, "permissions" \[ { "entityid" null, "operationuid" "d430853f c05f 61b4 d137 0237a6984032", "principal" { "name" "custom role 20231115", "iscustom" true, "type" "role", "id" 12345 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "2023 11 15t19 14 10 097z" } ] } ], "totalitemcount" 8, "matchingitemcount" 8, "pagesize" 1, "nextmarker" "cu20afjksdun78q932", "prevmarker" "cu20afjksdun7813rf", "istruncated" true, "sortexpression" "\[role] \[name] asc", "filterexpression" "" } failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error post / creates a role on a network required scope token bsn api main roles create request body the role entity (2022/06) docid\ b3xqot7ihhthnvacb0ngd request example the example request parameters and headers are set as follows post /2022/06/rest/roles/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate content type application/json content length 962 this is the example request body { "id" 0, "iscustom" true, "name" "custom role 20231115", "description" "", "creationdate" "0001 01 01t00 00 00", "usercount" 0, "users" null, "permissions" \[] } success response body 201 201 returns the role entity (2022/06) docid\ b3xqot7ihhthnvacb0ngd created and referenced by the uri (given by the location header field) in the response example { "id" 12345, "iscustom" true, "name" "custom role 20231115", "description" "", "creationdate" "2023 11 15t19 14 10 087z", "usercount" 0, "users" null, "permissions" \[] } failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error get /{id\ int}/ returns a specified role on a network required scope token bsn api main roles retrieve segment id int int a unique identifier for a role request example the example request parameters and headers are set as follows id is set to 12345 get /2022/06/rest/roles/12345/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response with body 200 200 returns the role entity (2022/06) docid\ b3xqot7ihhthnvacb0ngd example this is an example of a 200 level response { "id" 12345, "iscustom" true, "name" "custom role 20231115", "description" "", "creationdate" "2023 11 15t19 14 10 087z", "usercount" 1, "users" \[ { "login" "janedoe\@brightsign biz", "type" "user", "id" 54321 } ], "permissions" \[ { "entityid" null, "operationuid" "3a67ae65 aa94 477b acab 5291347cef2c", "principal" { "name" "custom role 20231115", "iscustom" true, "type" "role", "id" 12345 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "2023 12 01t16 37 19 553z" } ] } failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error put /{id\ int}/ updates the specified role on a network required scope token bsn api main roles update segment id int int a unique identifier for a role request body the role entity (2022/06) docid\ b3xqot7ihhthnvacb0ngd request example the example request parameters and headers are set as follows id is set to 12345 put /2022/06/rest/roles/12345/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate content type application/json content length 756 this is the example request body { "id" 0, "iscustom" true, "name" "custom role 20231115", "description" "", "creationdate" "0001 01 01t00 00 00", "usercount" 0, "users" null, "permissions" \[ { "entityid" null, "operationuid" "3a67ae65 aa94 477b acab 5291347cef2c", "principal" { "name" "custom role 20231115", "iscustom" true, "type" "role", "id" 12345 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "0001 01 01t00 00 00" } ] } success response 204 204 the role was successfully updated failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete /{id\ int}/ removes the specified custom role on a network required scope token bsn api main roles delete segment id int int a unique identifier for a custom role request example the example request parameters and headers are set as follows id is set to 12345 delete /2022/06/rest/roles/12345/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response 204 204 the specified role has been removed failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules (for example, if the user attempts to delete a system role) 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{name}/ returns the specified role on a network required scope token bsn api main roles retrieve segment name string string the name of the role request example the example request parameters and headers are set as follows name is set to custom role 20231115 get /2022/06/rest/roles/custom role 20231115/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response with body 200 200 returns the role entity (2022/06) docid\ b3xqot7ihhthnvacb0ngd example this is an example of a 200 level response { "id" 12345, "iscustom" true, "name" "custom role 20231115", "description" "", "creationdate" "2023 11 15t19 14 10 087z", "usercount" 1, "users" \[ { "login" "janedoe\@brightsign biz", "type" "user", "id" 54321 } ], "permissions" \[ { "entityid" null, "operationuid" "3a67ae65 aa94 477b acab 5291347cef2c", "principal" { "name" "custom role 20231115", "iscustom" true, "type" "role", "id" 12345 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "2023 12 01t16 37 19 553z" } ] } failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error put /{name}/ updates the specified role on a network required scope token bsn api main roles update segment name string string the name of the role request body the role entity (2022/06) docid\ b3xqot7ihhthnvacb0ngd request example the example request parameters and headers are set as follows name is set to custom role 20231115 put /2022/06/rest/roles/custom role 20231115/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate content type application/json content length 756 this is the example request body { "id" 0, "iscustom" true, "name" "custom role 20231115", "description" "", "creationdate" "0001 01 01t00 00 00", "usercount" 0, "users" null, "permissions" \[ { "entityid" null, "operationuid" "3a67ae65 aa94 477b acab 5291347cef2c", "principal" { "name" "custom role 20231115", "iscustom" true, "type" "role", "id" 12345 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "0001 01 01t00 00 00" } ] } success response 204 204 the role was successfully updated failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete /{name}/ removes the specified custom role on a network required scope token bsn api main roles delete segment name string string the name of the custom role request example the example request parameters and headers are set as follows name is set to custom role 20231116 delete /2022/06/rest/roles/custom role 20231116/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response 204 204 the specified role has been removed failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid, or it is rejected in accordance with the business rules (for example, if the user attempts to delete a system role) 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /operations/ returns operational permissions granted to roles for specific business operations required scope token bsn api main operations retrieve request example the example request parameters and headers are set as follows get /2022/06/rest/roles/operations/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body 200 200 returns the business operations entity (2022/06) docid\ ei98k7oul6z5i 5b d6js example { "uid" "027a307a a29d d674 a935 da468ef03091", "singularname" "full control", "pluralname" "role (full control)", "fullname" "role (full control)", "targetentity" "role", "appliance" "instance, collection", "parent" null, "descendants" \[ { "uid" "0b943c8f f889 2074 f152 014cff8c2e5d", "singularname" "view role", "pluralname" "view roles", "fullname" "role (full control) view roles", "targetentity" "role", "appliance" "instance, collection", "parent" { "uid" "027a307a a29d d674 a935 da468ef03091", "singularname" "full control", "pluralname" "role (full control)", "fullname" "role (full control)", "targetentity" "role", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "0b943c8f f889 2074 f152 014cff8c2e5d", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 16z" }, { "entityid" null, "operationuid" "0b943c8f f889 2074 f152 014cff8c2e5d", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 283z" }, { "entityid" null, "operationuid" "0b943c8f f889 2074 f152 014cff8c2e5d", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 38z" }, { "entityid" null, "operationuid" "0b943c8f f889 2074 f152 014cff8c2e5d", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 45z" }, { "entityid" null, "operationuid" "0b943c8f f889 2074 f152 014cff8c2e5d", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 62z" }, { "entityid" null, "operationuid" "0b943c8f f889 2074 f152 014cff8c2e5d", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 803z" } ] }, { "uid" "f7d768be c485 b4d4 5d98 bc80c329922c", "singularname" "view users", "pluralname" "view users", "fullname" "role (full control) view users", "targetentity" "role", "appliance" "instance, collection", "parent" { "uid" "027a307a a29d d674 a935 da468ef03091", "singularname" "full control", "pluralname" "role (full control)", "fullname" "role (full control)", "targetentity" "role", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "f7d768be c485 b4d4 5d98 bc80c329922c", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 16z" }, { "entityid" null, "operationuid" "f7d768be c485 b4d4 5d98 bc80c329922c", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 283z" }, { "entityid" null, "operationuid" "f7d768be c485 b4d4 5d98 bc80c329922c", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 38z" }, { "entityid" null, "operationuid" "f7d768be c485 b4d4 5d98 bc80c329922c", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 45z" }, { "entityid" null, "operationuid" "f7d768be c485 b4d4 5d98 bc80c329922c", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 62z" }, { "entityid" null, "operationuid" "f7d768be c485 b4d4 5d98 bc80c329922c", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 803z" } ] }, { "uid" "f2293374 b9bb 2a04 b192 e1e3fb9b013a", "singularname" "create role", "pluralname" "create role", "fullname" "role (full control) create role", "targetentity" "role", "appliance" "instance, collection", "parent" { "uid" "027a307a a29d d674 a935 da468ef03091", "singularname" "full control", "pluralname" "role (full control)", "fullname" "role (full control)", "targetentity" "role", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "f2293374 b9bb 2a04 b192 e1e3fb9b013a", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 16z" }, { "entityid" null, "operationuid" "f2293374 b9bb 2a04 b192 e1e3fb9b013a", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 283z" }, { "entityid" null, "operationuid" "f2293374 b9bb 2a04 b192 e1e3fb9b013a", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 38z" }, { "entityid" null, "operationuid" "f2293374 b9bb 2a04 b192 e1e3fb9b013a", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 45z" }, { "entityid" null, "operationuid" "f2293374 b9bb 2a04 b192 e1e3fb9b013a", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 62z" }, { "entityid" null, "operationuid" "f2293374 b9bb 2a04 b192 e1e3fb9b013a", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 803z" } ] }, { "uid" "5cd2960f 5361 a504 81bf 9496384d1c24", "singularname" "add user", "pluralname" "add user", "fullname" "role (full control) add user", "targetentity" "role", "appliance" "instance, collection", "parent" { "uid" "027a307a a29d d674 a935 da468ef03091", "singularname" "full control", "pluralname" "role (full control)", "fullname" "role (full control)", "targetentity" "role", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "5cd2960f 5361 a504 81bf 9496384d1c24", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 16z" }, { "entityid" null, "operationuid" "5cd2960f 5361 a504 81bf 9496384d1c24", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 283z" }, { "entityid" null, "operationuid" "5cd2960f 5361 a504 81bf 9496384d1c24", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 38z" }, { "entityid" null, "operationuid" "5cd2960f 5361 a504 81bf 9496384d1c24", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 45z" }, { "entityid" null, "operationuid" "5cd2960f 5361 a504 81bf 9496384d1c24", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 62z" }, { "entityid" null, "operationuid" "5cd2960f 5361 a504 81bf 9496384d1c24", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 803z" } ] }, { "uid" "a81a32c6 4291 05c4 71a2 6f899dc6da15", "singularname" "remove user", "pluralname" "remove user", "fullname" "role (full control) remove user", "targetentity" "role", "appliance" "instance, collection", "parent" { "uid" "027a307a a29d d674 a935 da468ef03091", "singularname" "full control", "pluralname" "role (full control)", "fullname" "role (full control)", "targetentity" "role", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "a81a32c6 4291 05c4 71a2 6f899dc6da15", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 16z" }, { "entityid" null, "operationuid" "a81a32c6 4291 05c4 71a2 6f899dc6da15", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 283z" }, { "entityid" null, "operationuid" "a81a32c6 4291 05c4 71a2 6f899dc6da15", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 38z" }, { "entityid" null, "operationuid" "a81a32c6 4291 05c4 71a2 6f899dc6da15", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 45z" }, { "entityid" null, "operationuid" "a81a32c6 4291 05c4 71a2 6f899dc6da15", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 62z" }, { "entityid" null, "operationuid" "a81a32c6 4291 05c4 71a2 6f899dc6da15", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 803z" } ] }, { "uid" "b38189a5 84d8 fba4 bd56 f71a5dfba6e6", "singularname" "edit permissions", "pluralname" "edit permissions", "fullname" "role (full control) edit permissions", "targetentity" "role", "appliance" "collection", "parent" { "uid" "027a307a a29d d674 a935 da468ef03091", "singularname" "full control", "pluralname" "role (full control)", "fullname" "role (full control)", "targetentity" "role", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "b38189a5 84d8 fba4 bd56 f71a5dfba6e6", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 16z" }, { "entityid" null, "operationuid" "b38189a5 84d8 fba4 bd56 f71a5dfba6e6", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 283z" }, { "entityid" null, "operationuid" "b38189a5 84d8 fba4 bd56 f71a5dfba6e6", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 38z" }, { "entityid" null, "operationuid" "b38189a5 84d8 fba4 bd56 f71a5dfba6e6", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 45z" }, { "entityid" null, "operationuid" "b38189a5 84d8 fba4 bd56 f71a5dfba6e6", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 62z" }, { "entityid" null, "operationuid" "b38189a5 84d8 fba4 bd56 f71a5dfba6e6", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 803z" } ] }, { "uid" "0a9b49c6 74a4 2834 15c6 606964e01f8b", "singularname" "update role", "pluralname" "update role", "fullname" "role (full control) update role", "targetentity" "role", "appliance" "collection", "parent" { "uid" "027a307a a29d d674 a935 da468ef03091", "singularname" "full control", "pluralname" "role (full control)", "fullname" "role (full control)", "targetentity" "role", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "0a9b49c6 74a4 2834 15c6 606964e01f8b", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 16z" }, { "entityid" null, "operationuid" "0a9b49c6 74a4 2834 15c6 606964e01f8b", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 283z" }, { "entityid" null, "operationuid" "0a9b49c6 74a4 2834 15c6 606964e01f8b", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 38z" }, { "entityid" null, "operationuid" "0a9b49c6 74a4 2834 15c6 606964e01f8b", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 45z" }, { "entityid" null, "operationuid" "0a9b49c6 74a4 2834 15c6 606964e01f8b", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 62z" }, { "entityid" null, "operationuid" "0a9b49c6 74a4 2834 15c6 606964e01f8b", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 803z" } ] }, { "uid" "30af3135 5514 2f64 75e1 d31e074c16d5", "singularname" "delete role", "pluralname" "delete role", "fullname" "role (full control) delete role", "targetentity" "role", "appliance" "instance, collection", "parent" { "uid" "027a307a a29d d674 a935 da468ef03091", "singularname" "full control", "pluralname" "role (full control)", "fullname" "role (full control)", "targetentity" "role", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "30af3135 5514 2f64 75e1 d31e074c16d5", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2024 01 03t01 44 13 16z" }, { "entityid" null, "operationuid" "30af3135 5514 2f64 75e1 d31e074c16d5", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 283z" }, { "entityid" null, "operationuid" "30af3135 5514 2f64 75e1 d31e074c16d5", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 38z" }, { "entityid" null, "operationuid" "30af3135 5514 2f64 75e1 d31e074c16d5", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 45z" }, { "entityid" null, "operationuid" "30af3135 5514 2f64 75e1 d31e074c16d5", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 62z" }, { "entityid" null, "operationuid" "30af3135 5514 2f64 75e1 d31e074c16d5", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2024 01 03t01 44 13 803z" } ] } ], "permissions" \[ { "entityid" null, "operationuid" "027a307a a29d d674 a935 da468ef03091", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2024 01 03t01 44 13 16z" }, { "entityid" null, "operationuid" "027a307a a29d d674 a935 da468ef03091", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2024 01 03t01 44 13 283z" }, { "entityid" null, "operationuid" "027a307a a29d d674 a935 da468ef03091", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2024 01 03t01 44 13 38z" }, { "entityid" null, "operationuid" "027a307a a29d d674 a935 da468ef03091", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2024 01 03t01 44 13 45z" }, { "entityid" null, "operationuid" "027a307a a29d d674 a935 da468ef03091", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2024 01 03t01 44 13 62z" }, { "entityid" null, "operationuid" "027a307a a29d d674 a935 da468ef03091", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2024 01 03t01 44 13 803z" } ] } failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{id\ int}/permissions/ includes object permissions granted to a given role required scope token bsn api main roles retrieve segment id int int a unique identifier for a role request example the example request parameters and headers are set as follows id is set to 12345 get /2022/06/rest/roles/12345/permissions/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body 200 200 returns an array of permission entity (2022/06) docid\ jwfymc42cdrg5jy2skysu entities granted to a given role example \[ { "entityid" null, "operationuid" "b41ac545 d505 7014 edde 51bc4c0d21a0", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 12345 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2020 08 17t20 49 46 35z" } ] failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error post /{id\ int}/permissions/ add permissions for specified roles on a network required scope token bsn api main roles update segment id int int a unique identifier for a role request body an array of permission entity (2022/06) docid\ jwfymc42cdrg5jy2skysu entities request example the example request parameters and headers are set as follows id is set to 12345 post /2022/06/rest/roles/12345/permissions/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate content type application/json content length 292 this is the example request body { "entityid" null, "operationuid" "b41ac545 d505 7014 edde 51bc4c0d21a0", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 12345 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "0001 01 01t00 00 00" } success response 204 204 the permissions were successfully added to the specified role failure response 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete /{id\ int}/permissions/ removes permissions for specified roles on a network required scope token bsn api main roles delete segment id int int a unique identifier for a role request body an array of permission entity (2022/06) docid\ jwfymc42cdrg5jy2skysu entities request example the example request parameters and headers are set as follows id is set to 12345 delete /2022/06/rest/roles/12345/permissions/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate content type application/json content length 359 this is the example request body { "entityid" null, "operationuid" "b41ac545 d505 7014 edde 51bc4c0d21a0", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 12345 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "0001 01 01t00 00 00" } success response 204 204 the specified permissions have been removed from the role failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{name}/permissions/ includes object permissions granted to a given role required scope token bsn api main roles retrieve segment name string string the name of the role request example the example request parameters and headers are set as follows name is set to creators get /2022/06/rest/roles/creators/permissions/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body 200 200 returns an array of permission entity (2022/06) docid\ jwfymc42cdrg5jy2skysu entities granted to a given role example \[ { "entityid" null, "operationuid" "b41ac545 d505 7014 edde 51bc4c0d21a0", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 12345 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2020 08 17t20 49 46 35z" } ] failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error post /{name}/permissions/ add permissions for specified roles on a network required scope token bsn api main roles update segment name string string the name of the role request body an array of permission entity (2022/06) docid\ jwfymc42cdrg5jy2skysu entities request example the example request parameters and headers are set as follows name is set to creators post /2022/06/rest/roles/creators/permissions/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate content type application/json content length 292 this is the example request body { "entityid" null, "operationuid" "b41ac545 d505 7014 edde 51bc4c0d21a0", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 12345 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "0001 01 01t00 00 00" } success response 204 204 the permissions were successfully added to the specified role failure response 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete /{name}/permissions/ removes permissions for specified role on a network required scope token bsn api main roles delete segment name string string the name of the role request body an array of permission entity (2022/06) docid\ jwfymc42cdrg5jy2skysu entities request example the example request parameters and headers are set as follows name is set to creators delete /2022/06/rest/roles/creators/permissions/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate content type application/json content length 359 this is the example request body { "entityid" null, "operationuid" "b41ac545 d505 7014 edde 51bc4c0d21a0", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 12345 }, "isfixed" false, "isinherited" false, "isallowed" false, "creationdate" "0001 01 01t00 00 00" } success response 204 204 the specified permissions have been removed from the role failure response 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error