Users Endpoints (2022/06)

these endpoints enable management of users on a network a user is an instance of a person that is associated with a single network (there can only be one person, but there can be 0 to an infinite number of users on a network) base url for these endpoints https //api bsn cloud/2022/06/rest/users get / returns a list of user instances on a network required scope token bsn api main users 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 user 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 user 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/users/?marker=ry0jlzw4tww3hcnmsmtcymu4\&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 success response body 200 200 returns a paged list entity (2022/06) docid\ pwwr0ln3 binngl mr3st of user entity (2022/06) docid 2fsbdemevbu2czlzcqnec 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, "person" { "id" 1234, "login" "johndoe\@look biz", "password" null, "firstname" "john", "lastname" "doe", "creationdate" "2020 07 09t19 05 20 247z", "lastmodifieddate" "2023 11 29t17 40 54 403z", "activationdate" "2020 07 09t19 05 38 723z" }, "description" "network administrator", "creationdate" "2020 07 09t19 09 04 98z", "lastmodifieddate" "2020 08 17t20 49 48 377z", "lastlogindate" "2024 01 03t17 55 26 17z", "islockedout" false, "lastlockoutdate" null, "rolename" "administrators", "permissions" \[ { "entityid" 123456, "operationuid" "67b9b0ab fb5f 36c4 d598 a71aa8998e4e", "principal" { "login" "johndoe\@look biz", "type" "user", "id" 12345 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 08 17t20 49 48 353z" } ] }], "totalitemcount" 2, "matchingitemcount" 2, "pagesize" 1, "nextmarker" "f32ry0jlzw4tww3hcnmumtcy00", "prevmarker" "f32ry0jlzw4tww3hcnmumt78th", "istruncated" false, "sortexpression" "\[user] \[person] \[login] 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 user instance on a network required scope token bsn api main users create request body the user entity (2022/06) docid 2fsbdemevbu2czlzcqnec request example the example request parameters and headers are set as follows post /2022/06/rest/users/ 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 468 this is the example request body { "id" 0, "person" { "id" 0, "login" "johndoe\@host com", "password" null, "firstname" "john", "lastname" "doe", "creationdate" "0001 01 01t00 00 00", "lastmodifieddate" "0001 01 01t00 00 00", "activationdate" null }, "description" "supervisor", "creationdate" "0001 01 01t00 00 00", "lastlogindate" null, "islockedout" false, "lastlockoutdate" null, "rolename" "viewers", "permissions" \[] } success response body 201 201 returns the user entity (2022/06) docid 2fsbdemevbu2czlzcqnec created and referenced by the uri (given by the location header field) in the response example { "id" 12345, "person" { "id" 12345, "login" "johndoe\@host com", "password" "7t#sqg7 ", "firstname" "john", "lastname" "doe", "creationdate" "2024 01 03t19 05 26 5480648z", "lastmodifieddate" "2024 01 03t19 05 26 5480648z", "activationdate" "2024 01 03t19 05 26 5480648z" }, "description" "supervisor", "creationdate" "2024 01 03t19 05 26 6198305z", "lastmodifieddate" "2024 01 03t19 05 26 9953066z", "lastlogindate" null, "islockedout" false, "lastlockoutdate" null, "rolename" "viewers", "permissions" \[ { "entityid" 30912, "operationuid" "67b9b0ab fb5f 36c4 d598 a71aa8998e4e", "principal" { "login" "johndoe\@host com", "type" "user", "id" 12345 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2024 01 03t19 05 26 9953066z" } ] } 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 /{login}/ returns information for a specified user on a network required scope token bsn api main users retrieve segment login string string the login information of the user request example the example request parameters and headers are set as follows login is set to janedoe\@brightsign biz the optional if modified since header value equals the last modified header value retrieved from the previous get /login or get /id response get /2022/06/rest/users/janedoe%40brightsign biz/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} if modified since wed, 20 dec 2023 21 32 34 gmt accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response with body 200 200 returns the user entity (2022/06) docid 2fsbdemevbu2czlzcqnec example this is an example of a successful 200 level response { "id" 123456, "person" { "id" 12345, "login" "janedoe\@brightsign biz", "password" null, "firstname" "jane", "lastname" "doe", "creationdate" "2020 07 09t19 05 20 247z", "lastmodifieddate" "2020 08 17t20 49 48 377z", "activationdate" "2020 07 09t19 05 38 723z" }, "description" "network administrator", "creationdate" "2020 07 09t19 09 04 98z", "lastmodifieddate" "2023 12 20t21 32 35 093z", "lastlogindate" "2024 01 03t19 05 23 98z", "islockedout" false, "lastlockoutdate" null, "rolename" "administrators", "permissions" \[ { "entityid" 123456, "operationuid" "67b9b0ab fb5f 36c4 d598 a71aa8998e4e", "principal" { "login" "janedoe\@brightsign biz", "type" "user", "id" 12345 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 08 17t20 49 48 353z" } ] } success response 304 304 the resource was not modified since the time specified in the “if modified since” header 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 /{login}/ updates information for a specified user on a network required scope token bsn api main users update segment login string string the login information of the user request body the user entity (2022/06) docid 2fsbdemevbu2czlzcqnec request example the example request parameters and headers are set as follows login is set to janedoe\@brightsign biz the optional if unmodified since header value equals the last modified header value retrieved from the get /id or get /login response put /2022/06/rest/users/janedoe%40brightsign biz/ 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 if unmodified since wed, 20 dec 2023 21 32 34 gmt content type application/json content length 1440 this is the example request body { "id" 123456, "person" { "id" 12345, "login" "janedoe\@brightsign biz", "password" null, "firstname" "jane", "lastname" "doe", "creationdate" "0001 01 01t00 00 00", "lastmodifieddate" "0001 01 01t00 00 00", "activationdate" "0001 01 01t00 00 00" }, "description" "network administrator", "creationdate" "0001 01 01t00 00 00", "lastmodifieddate" "0001 01 01t00 00 00", "lastlogindate" "0001 01 01t00 00 00", "islockedout" false, "lastlockoutdate" null, "rolename" "administrators", "permissions" \[ { "entityid" 123456, "operationuid" "67b9b0ab fb5f 36c4 d598 a71aa8998e4e", "principal" { "login" "janedoe\@brightsign biz", "type" "user", "id" 12345 }, "isfixed" false, "isinherited" false, "isallowed" true, "creationdate" "0001 01 01t00 00 00" } ] } success response 204 204 the user information has been 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) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 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 /{login}/ deletes the specified user on a network required scope token bsn api main users delete segment login string string the login information of the user request example the example request parameters and headers are set as follows login is set to johndoe\@host com the optional if unmodified since header value equals the last modified header value retrieved from the get /id or get /login response delete /2022/06/rest/users/johndoe%40host com/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} if unmodified since wed, 20 dec 2023 21 32 34 gmt accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response 204 204 the specified user information was successfully deleted 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 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) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 5xx 5xx any 500 code is an internal server error get /{id\ int}/ returns information for a specified user on a network required scope token bsn api main users retrieve segment id int int a unique identifier for a user request example the example request parameters and headers are set as follows id is set to 12345 the optional if modified since header value equals the last modified header value retrieved from the previous get /login or get /id response get /2022/06/rest/users/12345/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} if modified since wed, 20 dec 2023 21 32 34 gmt accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response with body 200 200 returns the user entity (2022/06) docid 2fsbdemevbu2czlzcqnec example this is an example of a 200 level response { "id" 12345, "person" { "id" 12345, "login" "janedoe\@brightsign biz", "password" null, "firstname" "jane", "lastname" "doe", "creationdate" "2020 07 09t19 05 20 247z", "lastmodifieddate" "2023 11 29t17 40 54 403z", "activationdate" "2020 07 09t19 05 38 723z" }, "description" "network administrator", "creationdate" "2020 07 09t19 09 04 98z", "lastmodifieddate" "2020 08 17t20 49 48 377z", "lastlogindate" "2024 01 03t19 05 23 98z", "islockedout" false, "lastlockoutdate" null, "rolename" "administrators", "permissions" \[ { "entityid" 123456, "operationuid" "67b9b0ab fb5f 36c4 d598 a71aa8998e4e", "principal" { "login" "janedoe\@brightsign biz", "type" "user", "id" 12345 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 08 17t20 49 48 353z" } ] } success response 304 304 the resource was not modified since the time specified in the “if modified since” header 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}/ update the given user instance required scope token bsn api main users update segment id int int a unique identifier for a user request body the user entity (2022/06) docid 2fsbdemevbu2czlzcqnec request example the example request parameters and headers are set as follows id is set to 12345 the optional if unmodified since header value equals the last modified header value retrieved from the get /id or get /login response put /2022/06/rest/users/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 if unmodified since wed, 20 dec 2023 21 32 34 gmt content type application/json content length 1440 this is the example request body { "id" 12345, "person" { "id" 12345, "login" "janedoe\@brightsign biz", "password" null, "firstname" "jane", "lastname" "doe", "creationdate" "0001 01 01t00 00 00", "lastmodifieddate" "0001 01 01t00 00 00", "activationdate" "0001 01 01t00 00 00" }, "description" "network administrator", "creationdate" "0001 01 01t00 00 00", "lastmodifieddate" "0001 01 01t00 00 00", "lastlogindate" "0001 01 01t00 00 00", "islockedout" false, "lastlockoutdate" null, "rolename" "administrators", "permissions" \[ { "entityid" 123456, "operationuid" "67b9b0ab fb5f 36c4 d598 a71aa8998e4e", "principal" { "login" "janedoe\@brightsign biz", "type" "user", "id" 12345 }, "isfixed" false, "isinherited" false, "isallowed" true, "creationdate" "0001 01 01t00 00 00" } ] } success response 204 204 the user information has been 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) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 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}/ deletes the specified user on a network required scope token bsn api main users delete segment id int int a unique identifier for a user request example the example request parameters and headers are set as follows id is set to 12345 the optional if unmodified since header value equals the last modified header value retrieved from the get /id or get /login response delete /2022/06/rest/users/12345/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} if unmodified since wed, 20 dec 2023 21 32 34 gmt accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response 204 204 the specified user information was successfully deleted 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) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 5xx 5xx any 500 code is an internal server error get /operations/ returns the 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/users/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" "b41ac545 d505 7014 edde 51bc4c0d21a0", "singularname" "full control", "pluralname" "user (full control)", "fullname" "user (full control)", "targetentity" "user", "appliance" "instance, collection", "parent" null, "descendants" \[ { "uid" "1a0c5653 9f2f 4274 f922 f68b17d2d3e7", "singularname" "view user", "pluralname" "view users", "fullname" "user (full control) view users", "targetentity" "user", "appliance" "instance, collection", "parent" { "uid" "b41ac545 d505 7014 edde 51bc4c0d21a0", "singularname" "full control", "pluralname" "user (full control)", "fullname" "user (full control)", "targetentity" "user", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "1a0c5653 9f2f 4274 f922 f68b17d2d3e7", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2023 04 21t19 10 01 147z" }, { "entityid" null, "operationuid" "1a0c5653 9f2f 4274 f922 f68b17d2d3e7", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 16z" }, { "entityid" null, "operationuid" "1a0c5653 9f2f 4274 f922 f68b17d2d3e7", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 177z" }, { "entityid" null, "operationuid" "1a0c5653 9f2f 4274 f922 f68b17d2d3e7", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 197z" }, { "entityid" null, "operationuid" "1a0c5653 9f2f 4274 f922 f68b17d2d3e7", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 357z" }, { "entityid" null, "operationuid" "1a0c5653 9f2f 4274 f922 f68b17d2d3e7", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 41z" } ] }, { "uid" "1af1f3e0 db38 2bc4 29fb f0f937139d89", "singularname" "create user", "pluralname" "create user", "fullname" "user (full control) create user", "targetentity" "user", "appliance" "collection", "parent" { "uid" "b41ac545 d505 7014 edde 51bc4c0d21a0", "singularname" "full control", "pluralname" "user (full control)", "fullname" "user (full control)", "targetentity" "user", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "1af1f3e0 db38 2bc4 29fb f0f937139d89", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2023 04 21t19 10 01 147z" }, { "entityid" null, "operationuid" "1af1f3e0 db38 2bc4 29fb f0f937139d89", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 16z" }, { "entityid" null, "operationuid" "1af1f3e0 db38 2bc4 29fb f0f937139d89", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 177z" }, { "entityid" null, "operationuid" "1af1f3e0 db38 2bc4 29fb f0f937139d89", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 197z" }, { "entityid" null, "operationuid" "1af1f3e0 db38 2bc4 29fb f0f937139d89", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 357z" }, { "entityid" null, "operationuid" "1af1f3e0 db38 2bc4 29fb f0f937139d89", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 41z" } ] }, { "uid" "d1d32f0f 39fd 435a bd49 35d76b9abdf2", "singularname" "manage notifications", "pluralname" "manage notifications", "fullname" "user (full control) manage notifications", "targetentity" "user", "appliance" "instance, collection", "parent" { "uid" "b41ac545 d505 7014 edde 51bc4c0d21a0", "singularname" "full control", "pluralname" "user (full control)", "fullname" "user (full control)", "targetentity" "user", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "d1d32f0f 39fd 435a bd49 35d76b9abdf2", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2023 04 21t19 10 01 16z" }, { "entityid" null, "operationuid" "d1d32f0f 39fd 435a bd49 35d76b9abdf2", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2023 04 21t19 10 01 36z" }, { "entityid" null, "operationuid" "d1d32f0f 39fd 435a bd49 35d76b9abdf2", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2023 04 21t19 10 01 41z" }, { "entityid" null, "operationuid" "d1d32f0f 39fd 435a bd49 35d76b9abdf2", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2023 04 21t19 10 01 147z" }, { "entityid" null, "operationuid" "d1d32f0f 39fd 435a bd49 35d76b9abdf2", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 177z" }, { "entityid" null, "operationuid" "d1d32f0f 39fd 435a bd49 35d76b9abdf2", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 197z" } ] }, { "uid" "cd9c31e0 d23c 1844 f9f8 dd49ce80e72a", "singularname" "change role", "pluralname" "change role", "fullname" "user (full control) change role", "targetentity" "user", "appliance" "instance, collection", "parent" { "uid" "b41ac545 d505 7014 edde 51bc4c0d21a0", "singularname" "full control", "pluralname" "user (full control)", "fullname" "user (full control)", "targetentity" "user", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "cd9c31e0 d23c 1844 f9f8 dd49ce80e72a", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2023 04 21t19 10 01 147z" }, { "entityid" null, "operationuid" "cd9c31e0 d23c 1844 f9f8 dd49ce80e72a", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 16z" }, { "entityid" null, "operationuid" "cd9c31e0 d23c 1844 f9f8 dd49ce80e72a", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 177z" }, { "entityid" null, "operationuid" "cd9c31e0 d23c 1844 f9f8 dd49ce80e72a", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 197z" }, { "entityid" null, "operationuid" "cd9c31e0 d23c 1844 f9f8 dd49ce80e72a", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 357z" }, { "entityid" null, "operationuid" "cd9c31e0 d23c 1844 f9f8 dd49ce80e72a", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 41z" } ] }, { "uid" "526a9b95 cce5 422a 99f8 9f02d63af74f", "singularname" "update user", "pluralname" "update user", "fullname" "user (full control) update user", "targetentity" "user", "appliance" "instance, collection", "parent" { "uid" "b41ac545 d505 7014 edde 51bc4c0d21a0", "singularname" "full control", "pluralname" "user (full control)", "fullname" "user (full control)", "targetentity" "user", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "526a9b95 cce5 422a 99f8 9f02d63af74f", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2023 04 21t19 10 01 147z" }, { "entityid" null, "operationuid" "526a9b95 cce5 422a 99f8 9f02d63af74f", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 16z" }, { "entityid" null, "operationuid" "526a9b95 cce5 422a 99f8 9f02d63af74f", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 177z" }, { "entityid" null, "operationuid" "526a9b95 cce5 422a 99f8 9f02d63af74f", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 197z" }, { "entityid" null, "operationuid" "526a9b95 cce5 422a 99f8 9f02d63af74f", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 357z" }, { "entityid" null, "operationuid" "526a9b95 cce5 422a 99f8 9f02d63af74f", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 41z" } ] }, { "uid" "52f1b86c 46df 8fa4 5d75 f0c8702975e6", "singularname" "edit permissions", "pluralname" "edit permissions", "fullname" "user (full control) edit permissions", "targetentity" "user", "appliance" "collection", "parent" { "uid" "b41ac545 d505 7014 edde 51bc4c0d21a0", "singularname" "full control", "pluralname" "user (full control)", "fullname" "user (full control)", "targetentity" "user", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "52f1b86c 46df 8fa4 5d75 f0c8702975e6", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2023 04 21t19 10 01 147z" }, { "entityid" null, "operationuid" "52f1b86c 46df 8fa4 5d75 f0c8702975e6", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 16z" }, { "entityid" null, "operationuid" "52f1b86c 46df 8fa4 5d75 f0c8702975e6", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 177z" }, { "entityid" null, "operationuid" "52f1b86c 46df 8fa4 5d75 f0c8702975e6", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 197z" }, { "entityid" null, "operationuid" "52f1b86c 46df 8fa4 5d75 f0c8702975e6", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 357z" }, { "entityid" null, "operationuid" "52f1b86c 46df 8fa4 5d75 f0c8702975e6", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 41z" } ] }, { "uid" "c244506f 4c57 4f66 88e0 ec2f05d06860", "singularname" "revoke tokens", "pluralname" "revoke tokens", "fullname" "user (full control) revoke tokens", "targetentity" "user", "appliance" "instance, collection", "parent" { "uid" "b41ac545 d505 7014 edde 51bc4c0d21a0", "singularname" "full control", "pluralname" "user (full control)", "fullname" "user (full control)", "targetentity" "user", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "c244506f 4c57 4f66 88e0 ec2f05d06860", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2023 04 21t19 10 01 147z" }, { "entityid" null, "operationuid" "c244506f 4c57 4f66 88e0 ec2f05d06860", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 16z" }, { "entityid" null, "operationuid" "c244506f 4c57 4f66 88e0 ec2f05d06860", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 177z" }, { "entityid" null, "operationuid" "c244506f 4c57 4f66 88e0 ec2f05d06860", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 197z" }, { "entityid" null, "operationuid" "c244506f 4c57 4f66 88e0 ec2f05d06860", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 357z" }, { "entityid" null, "operationuid" "c244506f 4c57 4f66 88e0 ec2f05d06860", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 41z" } ] }, { "uid" "51d92ebc fb22 c4f4 093f a737cba29ea8", "singularname" "lock user", "pluralname" "lock user", "fullname" "user (full control) lock user", "targetentity" "user", "appliance" "instance, collection", "parent" { "uid" "b41ac545 d505 7014 edde 51bc4c0d21a0", "singularname" "full control", "pluralname" "user (full control)", "fullname" "user (full control)", "targetentity" "user", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "51d92ebc fb22 c4f4 093f a737cba29ea8", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2023 04 21t19 10 01 147z" }, { "entityid" null, "operationuid" "51d92ebc fb22 c4f4 093f a737cba29ea8", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 16z" }, { "entityid" null, "operationuid" "51d92ebc fb22 c4f4 093f a737cba29ea8", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 177z" }, { "entityid" null, "operationuid" "51d92ebc fb22 c4f4 093f a737cba29ea8", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 197z" }, { "entityid" null, "operationuid" "51d92ebc fb22 c4f4 093f a737cba29ea8", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 357z" }, { "entityid" null, "operationuid" "51d92ebc fb22 c4f4 093f a737cba29ea8", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 41z" } ] }, { "uid" "3f15e37b 449b 1b24 fd32 d113af0a798a", "singularname" "unlock user", "pluralname" "unlock user", "fullname" "user (full control) unlock user", "targetentity" "user", "appliance" "instance, collection", "parent" { "uid" "b41ac545 d505 7014 edde 51bc4c0d21a0", "singularname" "full control", "pluralname" "user (full control)", "fullname" "user (full control)", "targetentity" "user", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "3f15e37b 449b 1b24 fd32 d113af0a798a", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2023 04 21t19 10 01 147z" }, { "entityid" null, "operationuid" "3f15e37b 449b 1b24 fd32 d113af0a798a", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 16z" }, { "entityid" null, "operationuid" "3f15e37b 449b 1b24 fd32 d113af0a798a", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 177z" }, { "entityid" null, "operationuid" "3f15e37b 449b 1b24 fd32 d113af0a798a", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 197z" }, { "entityid" null, "operationuid" "3f15e37b 449b 1b24 fd32 d113af0a798a", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 357z" }, { "entityid" null, "operationuid" "3f15e37b 449b 1b24 fd32 d113af0a798a", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 41z" } ] }, { "uid" "38b77fd8 16b6 9774 81e4 63af80fbbbb2", "singularname" "delete user", "pluralname" "delete user", "fullname" "user (full control) delete user", "targetentity" "user", "appliance" "instance, collection", "parent" { "uid" "b41ac545 d505 7014 edde 51bc4c0d21a0", "singularname" "full control", "pluralname" "user (full control)", "fullname" "user (full control)", "targetentity" "user", "appliance" "instance, collection", "parent" null, "descendants" null, "permissions" null }, "descendants" \[], "permissions" \[ { "entityid" null, "operationuid" "38b77fd8 16b6 9774 81e4 63af80fbbbb2", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" true, "isallowed" true, "creationdate" "2023 04 21t19 10 01 147z" }, { "entityid" null, "operationuid" "38b77fd8 16b6 9774 81e4 63af80fbbbb2", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 16z" }, { "entityid" null, "operationuid" "38b77fd8 16b6 9774 81e4 63af80fbbbb2", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 177z" }, { "entityid" null, "operationuid" "38b77fd8 16b6 9774 81e4 63af80fbbbb2", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 197z" }, { "entityid" null, "operationuid" "38b77fd8 16b6 9774 81e4 63af80fbbbb2", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 357z" }, { "entityid" null, "operationuid" "38b77fd8 16b6 9774 81e4 63af80fbbbb2", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" true, "isallowed" false, "creationdate" "2023 04 21t19 10 01 41z" } ] } ], "permissions" \[ { "entityid" null, "operationuid" "b41ac545 d505 7014 edde 51bc4c0d21a0", "principal" { "name" "administrators", "iscustom" false, "type" "role", "id" 1 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2023 04 21t19 10 01 147z" }, { "entityid" null, "operationuid" "b41ac545 d505 7014 edde 51bc4c0d21a0", "principal" { "name" "general managers", "iscustom" false, "type" "role", "id" 2 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2023 04 21t19 10 01 16z" }, { "entityid" null, "operationuid" "b41ac545 d505 7014 edde 51bc4c0d21a0", "principal" { "name" "creators", "iscustom" false, "type" "role", "id" 3 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2023 04 21t19 10 01 177z" }, { "entityid" null, "operationuid" "b41ac545 d505 7014 edde 51bc4c0d21a0", "principal" { "name" "publishers", "iscustom" false, "type" "role", "id" 4 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2023 04 21t19 10 01 197z" }, { "entityid" null, "operationuid" "b41ac545 d505 7014 edde 51bc4c0d21a0", "principal" { "name" "network managers", "iscustom" false, "type" "role", "id" 5 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2023 04 21t19 10 01 357z" }, { "entityid" null, "operationuid" "b41ac545 d505 7014 edde 51bc4c0d21a0", "principal" { "name" "viewers", "iscustom" false, "type" "role", "id" 6 }, "isfixed" true, "isinherited" false, "isallowed" false, "creationdate" "2023 04 21t19 10 01 41z" } ] } 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 for a given user instance required scope token bsn api main users retrieve segment id int int a unique identifier for a user request example the example request parameters and headers are set as follows id is set to 12345 get /2022/06/rest/users/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 example \[ { "entityid" 54321, "operationuid" "67b9b0ab fb5f 36c4 d598 a71aa8998e4e", "principal" { "login" "janedoe\@brightsign biz", "type" "user", "id" 12345 }, "isfixed" false, "isinherited" false, "isallowed" true, "creationdate" "2020 08 17t20 49 48 353z" } ] 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/ adds permissions for a specified user on a network required scope token bsn api main users update segment id int int a unique identifier for a user 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 12435 post /2022/06/rest/users/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 245 this is the example request body \[ { "entityid" 54321, "operationuid" "c978aa8d c7ac 410f aec3 22e136d0ba58", "principal" { "login" "janedoe\@brightsign biz", "type" "user", "id" 12345 }, "isfixed" false, "isinherited" false, "isallowed" true, "creationdate" "0001 01 01t00 00 00" } ] success response 204 204 the permissions were successfully added to the specified user instance 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 a specified user on a network required scope token bsn api main users update segment id int int a unique identifier for a user 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/users/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 245 this is the example request body \[ { "entityid" 54321, "operationuid" "39e69897 8d9a f634 95cf 7419a3e93c23", "principal" { "login" "janedoe\@brightsign biz", "type" "user", "id" 12345 }, "isfixed" false, "isinherited" false, "isallowed" true, "creationdate" "0001 01 01t00 00 00" } ] success response 204 204 the specified user permissions were successfully deleted 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 /{login}/permissions/ includes object permissions for a given user instance required scope token bsn api main users retrieve segment login string string the login information of the user request example the example request parameters and headers are set as follows login is set to johndoe\@brightsign biz get /2022/06/rest/users/johndoe%40brightsign biz/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 example \[ { "entityid" 54321, "operationuid" "67b9b0ab fb5f 36c4 d598 a71aa8998e4e", "principal" { "login" "johndoe\@brightsign biz", "type" "user", "id" 12345 }, "isfixed" false, "isinherited" false, "isallowed" true, "creationdate" "2020 08 17t20 49 48 353z" } ] 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 /{login}/permissions/ adds permissions for a specified user on a network required scope token bsn api main users update segment login string string the login information of the user request body an array of permission entity (2022/06) docid\ jwfymc42cdrg5jy2skysu entities request example the example request parameters and headers are set as follows login is set to johndoe\@brightsign biz post /2022/06/rest/users/johndoe%40brightsign biz/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 322 this is the example request body \[ { "entityid" 54321, "operationuid" "c978aa8d c7ac 410f aec3 22e136d0ba58", "principal" { "login" "johndoe\@brightsign biz", "type" "user", "id" 12345 }, "isfixed" false, "isinherited" false, "isallowed" true, "creationdate" "0001 01 01t00 00 00" } ] success response 204 204 the permissions were successfully added to the specified user instance 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 /{login}/permissions/ removes permissions for a specified user on a network required scope token bsn api main users update segment login string string the login information of the user request body an array of permission entity (2022/06) docid\ jwfymc42cdrg5jy2skysu entities request example the example request parameters and headers are set as follows login is set to johndoe\@brightsign biz delete /2022/06/rest/users/johndoe%40brightsign biz/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 232 this is the example request body \[ { "entityid" 54321, "operationuid" "39e69897 8d9a f634 95cf 7419a3e93c23", "principal" { "login" "johndoe\@brightsign biz", "type" "user", "id" 12345 }, "isfixed" false, "isinherited" false, "isallowed" true, "creationdate" "0001 01 01t00 00 00" } ] success response 204 204 the specified user permissions were successfully deleted 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 /{id\ int}/tokens/{token}/ validates the user access or refresh token granted to a specified user required scope token bsn api main users token validate segments id int int a unique identifier for a user token string string a user access or refresh token for a bsn cloud network request example the example request parameters and headers are set as follows id is set to 12345 token is set to {{useraccesstoken}} get /2022/06/rest/users/12345/tokens/{{useraccesstoken}}/ 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 token info entity (2022/06) docid\ rmbcir76z7ojsyjb u2pp example { "token" "{{useraccesstoken}}", "scope" "add device setup bsn api main bsn api self bsn api upload bsn ui main player", "validfrom" "2024 01 03t22 57 10z", "validto" "2024 01 03t23 12 10z" } 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 delete /{id\ int}/tokens/{token}/ revokes user access or refresh tokens for the specified user required scope token bsn api main users token revoke segments id int int a unique identifier for a user token string string the user access or refresh token to use with this endpoint call request example the example request parameters and headers are set as follows id is set to 12345 token is set to {{useraccesstoken}} delete /2022/06/rest/users/12345/tokens/{{useraccesstoken}}/ 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 user access or refresh token has been successfully revoked from the specified user 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 either the specified token is invalid, expired, or revoked, or it is issued for another user 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 /{login}/tokens/{token}/ validates the user access or refresh token granted to the specified user required scope token bsn api main users token validate segments login string string the login for a user token string string a user access or refresh token for a bsn cloud network request example the example request parameters and headers are set as follows login is set to johndoe\@brightsign biz token is set to {{useraccesstoken}} get /2022/06/rest/users/johndoe%40brightsign biz/tokens/{{useraccesstoken}}/ 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 token info entity (2022/06) docid\ rmbcir76z7ojsyjb u2pp example { "token" "{{useraccesstoken}}", "scope" "add device setup bsn api main bsn api self bsn api upload bsn ui main player", "validfrom" "2024 01 03t22 57 10z", "validto" "2024 01 03t23 12 10z" } 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 delete /{login}/tokens/{token}/ revokes the user access or refresh token granted to the specified user required scope token bsn api main users token revoke segments login string string the login for a user token string string a user access or refresh token for a bsn cloud network request example the example request parameters and headers are set as follows login is set to johndoe\@brightsign biz token is set to {{useraccesstoken}} delete /2022/06/rest/users/johndoe%40brightsign biz/tokens/{{useraccesstoken}}/ 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 user access or refresh token has been successfully revoked from the specified user 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 either the specified token is invalid, expired, or revoked, or it is issued for another user 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