Self Endpoints (2022/06)

88 min

these endpoints allow users to manage their settings in the current network base url for these endpoints https //api bsn cloud/2022/06/rest get /self/ returns your person entity docid\ vuywmgvg7yrdyb0atzg5k information required scope token bsn api self info retrieve request example the example request parameters and headers are set as follows the optional if modified since header value equals the last modified header value retrieved from the get /self/ response get /2022/06/rest/self/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{personaccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate if modified since wed, 29 nov 2023 17 40 51 gmt success response with body \200\ returns the person entity docid\ vuywmgvg7yrdyb0atzg5k example this is an example of a 200 level response { "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" } success response \304\ the resource was not modified since the time specified in the “if modified since” header failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \4\ \00\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error post /self/ registers the person and returns your person credentials (except the password if it was provided in your request) required scope token none request body the person entity docid\ vuywmgvg7yrdyb0atzg5k if you specify a password that matches our security policy, the server will apply the password you specify and will not return a password if you do not specify a password, the server will generate a password and return it to you request example the example request parameters and headers are set as follows post /2022/06/rest/self/ http/1 1 host api bsn cloud connection keep alive accept application/json, application/vnd bsn error+json accept encoding gzip,deflate content type application/json content length 309 this is the example request body { "id" 0, "login" "janedoe\@gmail com", "password" null, "firstname" "jane", "lastname" "doe", "creationdate" "0001 01 01t00 00 00", "lastmodifieddate" "0001 01 01t00 00 00", "activationdate" "0001 01 01t00 00 00" } success response body \200\ returns the person entity docid\ vuywmgvg7yrdyb0atzg5k example { "id" 12345, "login" "janedoe\@gmail com", "password" "7t#sqg7 ", "firstname" "jane", "lastname" "doe", "creationdate" "2023 12 01t16 47 03 3893279z", "lastmodifieddate" "2023 12 01t16 47 03 3893279z", "activationdate" null } failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \415\ the server cannot accept the data representation that you sent (as specified in the "content type" header) \5xx\ any 500 code is an internal server error \ any 500 code is an internal server error\ get /self/profile/ returns a complete person profile required scope token bsn api self profile retrieve request example the example request parameters and headers are set as follows get /2022/06/rest/self/profile/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{personaccesstoken}}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response with body \200\ the return type is object, where property names are profile keys and the profile values are those property values example { "personaccesstokenlifetime" "00 15 00", "personrefreshtokenlifetime" "1 00 00 00" } failure response \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \5xx\ any 500 code is an internal server error post /self/profile/ creates a new profile property for a person required scope token bsn api self profile update request body pair \\<string, string\> \ a key value pair of the person profile property request example the example request parameters and headers are set as follows post /2022/06/rest/self/profile/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{personaccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate content type application/json content length 44 this is the example request body { 	"key" "newproperty1", 	"value" "111" } success response body \201\ returns the new resource created and referenced by the uri (given by the location header field) in the response returns an object where property names correspond to profile keys and property values correspond to profile names example { "key" "newproperty1", "value" "111" } failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ either the request is malformed and therefore invalid, or the specified profile property key is reserved or longer than 62 characters \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \409\ the person profile property with the specified key already exists \413\ the length of the specified person property profile value exceeds the 64kb limit \415\ the server cannot accept the data representation that you sent (as specified in the "content type" header) \5xx\ any 500 code is an internal server error get /self/profile/{key}/ returns a profile property value for a person required scope token bsn api self profile retrieve segment key \string \ the name of the profile property request example the example request parameters and headers are set as follows key is set to personaccesstokenlifetime get /2022/06/rest/self/profile/personaccesstokenlifetime/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{personaccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body \200\ returns a profile property value example this is an example of a 200 level response "00 15 00" success response \304\ the resource was not modified since the time specified in the “if modified since” header failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error put /self/profile/{key}/ creates or updates a person profile property value required scope token bsn api self profile update segment key \string \ the name of the profile property request body \string \ the profile property value to update request example the example request parameters and headers are set as follows key is set to personrefreshtokenlifetime put /2022/06/rest/self/profile/personrefreshtokenlifetime/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{personaccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate content type application/json content length 12 this is the example request body "1 00 00 00" success response \201\ returns this status code if the person property value is defined for first time \204\ returns this status code if the person property value already exists and has been updated failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \412\ precondition failed (the resource changed since the time specified in the “if unmodified since” header value) \413\ the length of the specified user profile property exceeds the 64kb limit \415\ the server cannot accept the data representation that you sent (as specified in the "content type" header) \5xx\ any 500 code is an internal server error delete /self/profile/{key}/ removes a profile property for a person required scope token bsn api self profile update segment key \string \ the name of the profile property request example the example request parameters and headers are set as follows key is set to newproperty1 delete /2022/06/rest/self/profile/newproperty1/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{personaccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response \204\ the profile property has been removed failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \412\ precondition failed (the resource changed since the time specified in the “if unmodified since” header value) \5xx\ any 500 code is an internal server error get /self/session/ retrieves the complete set of attributes defined in the context of the current person session request example the example request parameters and headers are set as follows the optional if modified since header value equals the last modified header value retrieved from the previous get /self/session/ response get /2022/06/rest/self/session/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{accesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate if modified since wed, 29 nov 2023 17 40 51 gmt success response with body \200\ returns the session context structure docid\ qfk7vzwehsywcwtxsghts example { "network" { "id" 12345, "name" "johndoe" }, "authorizationscope" "bsn api main bsn api self bsn api upload bsn ui main player", "lastmodifieddate" "2024 08 08t16 10 13 673z" } \304\ the provided if modified since http header value matches the timestamp of the current attribute value assignment failure response \400\ the request is malformed and therefore invalid \401\ the provided person access token is invalid and the session id cannot be retrieved \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \410\ the provided person access token is valid but the session with resolved id has been invalidated \5xx\ any 500 code is an internal server error get /self/session/network/ retrieves the identifiers of the network that the current user is signed into request example the example request parameters and headers are set as follows get /2022/06/rest/self/session/network/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{accesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response with body \200\ returns the requested attribute value, which is either the network info entity docid 5ki8drpaxhs07haxvt5gg or null if the current person is not signed into any network example { "id" 12345, "name" "johndoe" } \204\ the request is executed successfully, but there is no content to return (the network is not set in the context of the current session) failure response \400\ the request is malformed and therefore invalid \401\ the provided person access token is invalid and the session id cannot be retrieved \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \410\ the provided person access token is valid but the session with the resolved id has been invalidated \5xx\ any 500 code is an internal server error put /self/session/network/ allows a person to set or change a network the person is signed into in scope of the current session request example the example request parameters and headers are set as follows put /2022/06/rest/self/session/network/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{accesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate content type application/json content length 40 this is the example request body { "id" 12345, "name" "janedoe" } success response with body \204\ the person is successfully signed into the specified network failure response \400\ invalid request and any of the following business rules violations the provided network info entity docid 5ki8drpaxhs07haxvt5gg has an invalid format neither network id not network name is specified in the request a network with the specified id or name does not exist a network with the specified id or name is suspended the person who owns the provided access token is not a member of the network with the specified id or name the person in the network with the specified id or name is disabled \401\ the provided person access token is invalid and the session id cannot be retrieved \410\ the provided person access token is valid but the session with the resolved id has been invalidated \5xx\ any 500 code is an internal server error get /self/session/authorizationscope/ retrieves the scope of actions the current user is authorized to do with the provided access token request example the example request parameters and headers are set as follows get /2022/06/rest/self/session/authorizationscope/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{accesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response with body \200\ returns the space separated list of tokens which represent the available resources example "bsn api main bsn api self bsn api upload bsn ui main player" failure response \400\ the request is malformed and therefore invalid \401\ the provided person access token is invalid and the session id cannot be retrieved \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \410\ the provided person access token is valid but the session with the resolved id has been invalidated \5xx\ any 500 code is an internal server error put /self/session/authorizationscope/ allows a person to change the list of resources he is authorized to access with the provided access token request example the example request parameters and headers are set as follows put /2022/06/rest/self/session/authorizationscope/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{accesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate content type application/json content length 40 this is the example request body "bsn api main bsn api self bsn api upload bsn ui main player" success response \204\ the authorization scope has been successfully updated failure response \400\ invalid request and any of the following business rules violations the provided authorization scope has an invalid format one or more specified scope tokens are not available with the provided token \401\ the provided person access token is invalid and the session id cannot be retrieved \410\ the provided person access token is valid but the session with the resolved id has been invalidated \5xx\ any 500 code is an internal server error get /self/tokens/{token}/ gets the status of the specified oauth2 person access or refresh token required scope token bsn api self token validate segment token \string \ a person access or refresh token request example the example request parameters and headers are set as follows token is set to {{token}} get /2022/06/rest/self/tokens/{{token}}/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{personaccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body \200\ returns the token info entity docid\ rmbcir76z7ojsyjb u2pp example { "token" {{token}}, "scope" "bsn api self", "validfrom" "2023 11 29t17 43 55z", "validto" "2023 11 29t17 58 55z" } failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the specified person or access refresh token is expired, revoked, or invalid \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error delete /self/tokens/{token}/ revokes a person access or refresh token required scope token bsn api self token revoke segment token \string \ a person access or refresh token request example the example request parameters and headers are set as follows token is set to {{token}} delete /2022/06/rest/self/tokens/{{token}}/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{personaccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response \204\ the person access or refresh token has been deleted failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the specified person or access refresh token is expired, revoked, or invalid \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error get /self/networks/ returns the networks associated with a person required scope token bsn api self networks retrieve request example the example request parameters and headers are set as follows get /2022/06/rest/self/networks/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{personaccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body \200\ returns an array of network entity docid\ y77uiecedvnrz0wes8vpl instances in which the current person is a member example \[ { "id" 12345, "name" "controlcloud network1", "creationdate" "2020 07 14t18 40 58 087z", "lastmodifieddate" "2020 07 14t18 40 58 087z", "lockoutdate" null, "islockedout" false, "lastlockoutdate" null, "settings" { "useraccesstokenlifetime" "00 15 00", "userrefreshtokenlifetime" "1 00 00 00", "deviceaccesstokenlifetime" "00 15 00", "devicerefreshtokenlifetime" "730 00 00 00", "deviceregistrationtokenlifetime" "730 00 00 00", "automatictaggedplaylistapprovalenabled" false, "lastmodifieddate" "2020 07 14t18 41 00 613z" }, "subscription" { "id" 12345, "level" "control", "creationdate" "2020 07 14t18 40 58 783z", "lastmodifieddate" "2020 07 14t18 40 58 783z", "expiredate" null } } ] failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error post /self/networks/ creates a network for the person required scope token bsn api self networks create request body the network entity docid\ y77uiecedvnrz0wes8vpl request example the example request parameters and headers are set as follows post /2022/06/rest/self/networks/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{personaccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate content type application/json content length 581 this is the example request body { "id" 0, "name" "testdisplay", "creationdate" "0001 01 01t00 00 00", "lastmodifieddate" "0001 01 01t00 00 00", "lockoutdate" null, "islockedout" false, "lastlockoutdate" null, "settings" { "useraccesstokenlifetime" "00 15 00", "userrefreshtokenlifetime" "1 00 00 00", "deviceaccesstokenlifetime" "00 15 00", "devicerefreshtokenlifetime" "730 00 00 00", "deviceregistrationtokenlifetime" "730 00 00 00", "automatictaggedplaylistapprovalenabled" false, "lastmodifieddate" "0001 01 01t00 00 00" }, "subscription" null } success response body \201\ returns the new resource created and referenced by the uri (given by the location header field) in the response the response includes the network entity (see network entity docid\ y77uiecedvnrz0wes8vpl ) example { "id" 12345, "name" "testdisplay", "creationdate" "2023 12 07t18 29 58 5041056z", "lastmodifieddate" "2023 12 07t18 29 58 5041056z", "lockoutdate" null, "islockedout" false, "lastlockoutdate" null, "settings" { "useraccesstokenlifetime" "00 15 00", "userrefreshtokenlifetime" "1 00 00 00", "deviceaccesstokenlifetime" "00 15 00", "devicerefreshtokenlifetime" "730 00 00 00", "deviceregistrationtokenlifetime" "730 00 00 00", "automatictaggedplaylistapprovalenabled" false, "lastmodifieddate" "2023 12 07t18 29 58 5041056z" }, "subscription" { "id" 12345, "level" "control", "creationdate" "2023 12 07t18 29 58 5142438z", "lastmodifieddate" "2023 12 07t18 29 58 5142438z", "expiredate" null } } failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \415\ the server cannot accept the data representation that you sent (as specified in the "content type" header) \5xx\ any 500 code is an internal server error get /self/networks/{id}/ get a network associated with a specified id required scope token bsn api self networks retrieve segment id \int \ the unique identifier for a network request example the example request parameters and headers are set as follows id is set to 12345 get /2022/06/rest/self/networks/12345/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{personaccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response with body \200\ returns the network entity docid\ y77uiecedvnrz0wes8vpl example this is an example of a 200 level response { "id" 12345, "name" "janedoetesting", "creationdate" "2020 07 09t19 09 04 937z", "lastmodifieddate" "2020 07 09t19 09 04 937z", "lockoutdate" null, "islockedout" false, "lastlockoutdate" null, "settings" { "useraccesstokenlifetime" "00 15 00", "userrefreshtokenlifetime" "1 00 00 00", "deviceaccesstokenlifetime" "00 15 00", "devicerefreshtokenlifetime" "730 00 00 00", "deviceregistrationtokenlifetime" "730 00 00 00", "automatictaggedplaylistapprovalenabled" false, "lastmodifieddate" "2020 07 09t19 09 06 77z" }, "subscription" { "id" 12345, "level" "content", "creationdate" "2020 08 17t20 49 45 633z", "lastmodifieddate" "2020 08 17t20 49 45 633z", "expiredate" "2030 08 16t00 00 00z" } } success response \304\ the resource was not modified since the time specified in the “if modified since” header failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error patch /self/networks/{networkid}/ applies changes to a network associated with a specified id required scope token bsn api self networks update segment networkid \int \ the unique identifier for a network request body these properties are entries in an array every entry must have all three of these properties op \string\ the type of operation in this case it is always "replace" path \string\ a uri path that references the location within the target document where the update will be performed value \object\ the replacement value(s) for the parameters that must be updated this can be an array request example the example request parameters and headers are set as follows networkid is set to 12345 patch /2022/06/rest/self/networks/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 patch+json content length 94 this is the example request body \[ { "op" "replace", "path" "/subscription/level/", "value" "trial" } ] success response \204\ the parameters have been successfully replaced failure response \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \412\ precondition failed (the resource changed since the time specified in the “if unmodified since” header value) \415\ the server cannot accept the data representation that you sent (as specified in the "content type" header) \5xx\ any 500 code is an internal server error get /self/networks/{name}/ returns a network associated with a specified name required scope token bsn api self networks retrieve segment name \string \ the name of a network request example the example request parameters and headers are set as follows name is set to janedoetesting get /2022/06/rest/self/networks/janedoetesting/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{personaccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body \200\ returns the network entity docid\ y77uiecedvnrz0wes8vpl example this is an example of a 200 level response { "id" 12345, "name" "janedoetesting", "creationdate" "2020 07 09t19 09 04 937z", "lastmodifieddate" "2020 07 09t19 09 04 937z", "lockoutdate" null, "islockedout" false, "lastlockoutdate" null, "settings" { "useraccesstokenlifetime" "00 15 00", "userrefreshtokenlifetime" "30 00 00 00", "deviceaccesstokenlifetime" "00 15 00", "devicerefreshtokenlifetime" "730 00 00 00", "deviceregistrationtokenlifetime" "730 00 00 00", "automatictaggedplaylistapprovalenabled" false, "lastmodifieddate" "2023 12 07t21 41 44 01z" }, "subscription" { "id" 12345, "level" "content", "creationdate" "2020 08 17t20 49 45 633z", "lastmodifieddate" "2020 08 17t20 49 45 633z", "expiredate" "2030 08 16t00 00 00z" } } success response \304\ the resource was not modified since the time specified in the “if modified since” header failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error patch /self/networks/{networkname}/ applies changes to a network associated with a specified id required scope token bsn api self networks update segment networkname \string \ the name of the network request body these properties are entries in an array every entry must have all three of these properties op \string\ the type of operation in this case it is always "replace" path \string\ a uri path that references the location within the target document where the update will be performed value \object\ the replacement value(s) for the parameters that must be updated this can be an array request example the example request parameters and headers are set as follows networkname is set to janedoetesting patch /2022/06/rest/self/networks/janedoetesting/ 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 patch+json content length 94 this is the example request body \[ { "op" "replace", "path" "/subscription/level/", "value" "trial" } ] success response \204\ the parameters have been successfully replaced failure response \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \412\ precondition failed (the resource changed since the time specified in the “if unmodified since” header value) \415\ the server cannot accept the data representation that you sent (as specified in the "content type" header) \5xx\ any 500 code is an internal server error get /self/networks/{id}/settings/ returns the settings associated with a specified network required scope token bsn api self networks retrieve segment id \int \ the unique identifier for a network request example the example request parameters and headers are set as follows id is set to 12345 get /2022/06/rest/self/networks/12345/settings/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{personaccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response with body \200\ returns the network settings entity docid\ uaqtzanltnrcjbzf4vjdw example this is an example of a 200 level response { "useraccesstokenlifetime" "00 15 00", "userrefreshtokenlifetime" "1 00 00 00", "deviceaccesstokenlifetime" "00 15 00", "devicerefreshtokenlifetime" "730 00 00 00", "deviceregistrationtokenlifetime" "730 00 00 00", "automatictaggedplaylistapprovalenabled" false, "lastmodifieddate" "2020 07 09t19 09 06 77z" } success response \304\ the resource was not modified since the time specified in the “if modified since” header failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error put /self/networks/{id}/settings/ update the settings associated with a specified network required scope token bsn api self networks update segment id \int \ the unique identifier for a network request body the network settings entity docid\ uaqtzanltnrcjbzf4vjdw request example the example request parameters and headers are set as follows id is set to 12345 put /2022/06/rest/self/networks/12345/settings/ 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 335 this is the example request body { "useraccesstokenlifetime" "00 15 00", "userrefreshtokenlifetime" "30 00 00 00", "deviceaccesstokenlifetime" "00 15 00", "devicerefreshtokenlifetime" "730 00 00 00", "deviceregistrationtokenlifetime" "730 00 00 00", "automatictaggedplaylistapprovalenabled" false, "lastmodifieddate" "0001 01 01t00 00 00" } success response \204\ the specified settings have been updated on the network failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \415\ the server cannot accept the data representation that you sent (as specified in the "content type" header) \5xx\ any 500 code is an internal server error get /self/networks/{name}/settings/ get the settings associated with a specified network required scope token bsn api self networks retrieve segment name \string \ the network name request example the example request parameters and headers are set as follows id is set to janedoetesting get /2022/06/rest/self/networks/janedoetesting/settings/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{personaccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body \200\ returns the network settings entity docid\ uaqtzanltnrcjbzf4vjdw example { "useraccesstokenlifetime" "00 15 00", "userrefreshtokenlifetime" "1 00 00 00", "deviceaccesstokenlifetime" "00 15 00", "devicerefreshtokenlifetime" "730 00 00 00", "deviceregistrationtokenlifetime" "730 00 00 00", "automatictaggedplaylistapprovalenabled" false, "lastmodifieddate" "2020 07 09t19 09 06 77z" } failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error put /self/networks/{name}/settings/ update the settings associated with a specified network required scope token bsn api self networks update segment name \string \ the network name request body the network settings entity docid\ uaqtzanltnrcjbzf4vjdw request example the example request parameters and headers are set as follows name is set to janedoetesting put /2022/06/rest/self/networks/janedoetesting/settings/ 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 335 this is the example request body { "useraccesstokenlifetime" "00 15 00", "userrefreshtokenlifetime" "30 00 00 00", "deviceaccesstokenlifetime" "00 15 00", "devicerefreshtokenlifetime" "730 00 00 00", "deviceregistrationtokenlifetime" "730 00 00 00", "automatictaggedplaylistapprovalenabled" false, "lastmodifieddate" "0001 01 01t00 00 00" } success response \204\ the network settings have been updated failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \415\ the server cannot accept the data representation that you sent (as specified in the "content type" header) \5xx\ any 500 code is an internal server error get /self/networks/{id}/subscription/ returns the current subscription information associated with a specified network required scope token bsn api self networks retrieve segment id \int \ the unique identifier for a network request example the example request parameters and headers are set as follows id is set to 12345 get /2022/06/rest/self/networks/12345/subscription/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{personaccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response with body \200\ returns the network subscription entity docid 4aekl8ouwp1jzomqcj2id example this is an example of a 200 level response { "id" 12345, "level" "content", "creationdate" "2020 08 17t20 49 45 633z", "lastmodifieddate" "2020 08 17t20 49 45 633z", "expiredate" "2030 08 16t00 00 00z" } success response \304\ the resource was not modified since the time specified in the “if modified since” header failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error put /self/networks/{id}/subscription/ updates the current subscription information associated with a specified network a regular user can only use this to enable a trial period of the content cloud (if it was not previously enabled) required scope token bsn api self networks update segment id \int \ the unique identifier for a network request body the network subscription entity docid 4aekl8ouwp1jzomqcj2id request example the example request parameters and headers are set as follows id is set to 12345 put /2022/06/rest/self/networks/12345/subscription/ 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 114 this is the example request body { "id" 0, "level" "trial", "creationdate" "0001 01 01t00 00 00", "lastmodifieddate" "0001 01 01t00 00 00", "expiredate" null } success response \204\ the subscription information was updated failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \412\ precondition failed (the resource changed since the time specified in the “if unmodified since” header value) \415\ the server cannot accept the data representation that you sent (as specified in the "content type" header) \5xx\ any 500 code is an internal server error get /self/networks/{name}/subscription/ returns the current subscription information associated with a specified network required scope bsn api self networks retrieve segment name \string \ the network name request example the example request parameters and headers are set as follows name is set to janedoetesting get /2022/06/rest/self/networks/janedoetesting/subscription/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{personaccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body \200\ returns the network subscription entity docid 4aekl8ouwp1jzomqcj2id example { "id" 12345, "level" "trial", "creationdate" "2020 08 17t20 49 45 633z", "lastmodifieddate" "2020 08 17t20 49 45 633z", "expiredate" "2030 08 16t00 00 00z" } failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error put /self/networks/{name}/subscription/ updates the current subscription information associated with a specified network a regular user can only use this to enable a trial period of the content cloud (if it was not previously enabled) required scope token bsn api self networks update segment name \string \ the network name request body the network subscription entity docid 4aekl8ouwp1jzomqcj2id request example the example request parameters and headers are set as follows name is set to janedoetesting put /2022/06/rest/self/networks/janedoetesting/subscription/ 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 114 this is the example request body { "id" 0, "level" "trial", "creationdate" "0001 01 01t00 00 00", "lastmodifieddate" "0001 01 01t00 00 00", "expiredate" null } success response \204\ updated the subscription information associated with the network failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \415\ the server cannot accept the data representation that you sent (as specified in the "content type" header) \5xx\ any 500 code is an internal server error get /self/networks/{id}/subscriptions/ returns the current subscription, and all previously expired subscriptions, associated with a specified network required scope token bsn api self networks retrieve segment id \int \ the network identifier request example the example request parameters and headers are set as follows id is set to 12345 get /2022/06/rest/self/networks/12345/subscriptions/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{personaccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body \200\ returns an array of network subscription docid 4aekl8ouwp1jzomqcj2id entities example \[ { "id" 12347, "level" "content", "creationdate" "2020 08 17t20 49 45 633z", "lastmodifieddate" "2020 08 17t20 49 45 633z", "expiredate" "2030 08 16t00 00 00z" }, { "id" 12346, "level" "trial", "creationdate" "2020 07 24t23 05 45 517z", "lastmodifieddate" "2020 07 24t23 05 45 517z", "expiredate" "2020 08 17t20 49 45 633z" }, { "id" 12345, "level" "control", "creationdate" "2020 07 09t19 09 05 853z", "lastmodifieddate" "2020 07 09t19 09 05 853z", "expiredate" "2020 07 24t23 05 45 517z" } ] failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error get /self/networks/{name}/subscriptions/ returns the current subscription, and all previously expired subscriptions, associated with a specified network required scope token bsn api self networks retrieve segment name \string \ the network name request example the example request parameters and headers are set as follows name is set to janedoetesting get /2022/06/rest/self/networks/janedoetesting/subscriptions/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{personaccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body \200\ returns an array of network subscription docid 4aekl8ouwp1jzomqcj2id entities example \[ { "id" 12347, "level" "content", "creationdate" "2020 08 17t20 49 45 633z", "lastmodifieddate" "2020 08 17t20 49 45 633z", "expiredate" "2030 08 16t00 00 00z" }, { "id" 12346, "level" "trial", "creationdate" "2020 07 24t23 05 45 517z", "lastmodifieddate" "2020 07 24t23 05 45 517z", "expiredate" "2020 08 17t20 49 45 633z" }, { "id" 12345, "level" "control", "creationdate" "2020 07 09t19 09 05 853z", "lastmodifieddate" "2020 07 09t19 09 05 853z", "expiredate" "2020 07 24t23 05 45 517z" } ] failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error get /self/users/ returns all user entities that the customer is associated with over all networks where the person has a user record required scope token bsn api self users retrieve request example the example request parameters and headers are set as follows get /2022/06/rest/self/users/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{personaccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body \200\ returns an array of user entities (see user entity docid 2fsbdemevbu2czlzcqnec ) if the user is a member of multiple networks, or to a single user entity docid 2fsbdemevbu2czlzcqnec if the user is only a member of one network, or nothing if the user is not a member of any network example \[ { "id" 12345, "person" { "id" 1234, "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" }, "network" { "id" 1234, "name" "janedoetesting" }, "description" "network administrator", "creationdate" "2020 07 09t19 09 04 98z", "lastmodifieddate" "2020 08 17t20 49 48 377z", "lastlogindate" "2023 12 07t22 11 53 24z", "islockedout" false, "lastlockoutdate" null, "rolename" "administrators", "permissions" \[ { "entityid" 54321, "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" } ] } ] failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error get /self/users/{id}/ returns information about your membership in a network required scope token bsn api self users retrieve segment id \int \ the 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/self/users/12345/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{personaccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response with body \200\ returns the user entity docid 2fsbdemevbu2czlzcqnec example this is an example of a 200 level response { "id" 12345, "person" { "id" 1234, "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" }, "network" { "id" 1234, "name" "janedoetesting" }, "description" "network administrator", "creationdate" "2020 07 09t19 09 04 98z", "lastmodifieddate" "2020 08 17t20 49 48 377z", "lastlogindate" "2023 12 07t22 11 53 24z", "islockedout" false, "lastlockoutdate" null, "rolename" "administrators", "permissions" \[ { "entityid" 54321, "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\ the resource was not modified since the time specified in the “if modified since” header failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error get /self/users/{id}/role/ returns information about the role you have in a network required scope token bsn api self roles retrieve segment id \int \ the 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/self/users/12345/role/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{personaccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response with body \200\ this returns the user entity docid 2fsbdemevbu2czlzcqnec example this is an example of a 200 level response { "id" 12345, "iscustom" true, "name" "customrole", "description" "", "creationdate" "2023 07 10t14 16 58 433z", "usercount" 1, "users" null, "permissions" \[ { "entityid" null, "operationuid" "b41ac545 d505 7014 edde 51bc4c0d21a0", "principal" { "name" "customrole", "iscustom" true, "type" "role", "id" 12345 }, "isfixed" false, "isinherited" false, "isallowed" true, "creationdate" "2023 08 17t20 49 45 793z" } ] } success response \204\ no content (the user is not assigned to a role) failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error get /self/users/{id}/profile/ returns the user profile settings required scope token bsn api self users profile retrieve segment id \int \ the 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/self/users/12345/profile/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{personaccesstoken}} accept application/json, application/vnd bsn error+json accept encoding gzip,deflate success response body \200\ the return type is object, where property names are profile keys and the profile values are those property values example { "enablecustomrolesmanagement" "true", "showadvancedsecuritysettings" "false" } failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error post /self/users/{id}/profile/ creates a new user profile property (it does not replace an existing user profile property) required scope token bsn api self users profile update segment id \int \ the unique identifier for a user request body pair \\<string, string\> \ a key value pair there should be not more than 100 properties per user, and each property value should be not more than 64kb request example the example request parameters and headers are set as follows id is set to 12345 post /2022/06/rest/self/users/12345/profile/ 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 45 this is the example request body { 	"key" "new key 1", 	"value" "my value" } success response body \201\ returns the key value pair and a link to the get method to retrieve it example { "key" "new key 1", "value" "my value" } failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \409\ the profile property with the specified key already exists or is reserved \413\ the specified profile property value size exceeds the 64kb limit \415\ the server cannot accept the data representation that you sent (as specified in the "content type" header) \5xx\ any 500 code is an internal server error get /self/users/{id}/profile/{key}/ returns the value of a user profile property required scope token bsn api self users profile retrieve segment id \int \ the unique identifier for a user key \string \ the name of the profile property request example the example request parameters and headers are set as follows id is set to 12345 key is set to new key 1 get /2022/06/rest/self/users/12345/profile/new%20key%201 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\ returns the value of the requested user profile key example this is an example of a status 200 response "my value" success response \304\ the resource was not modified since the time specified in the “if modified since” header failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error put /self/users/{id}/profile/{key}/ creates or updates the value of a user profile property required scope token bsn api self users profile update segments id \int \ the unique identifier for a user key \string \ the name of the profile property request body \string \ the profile property value to update request example the example request parameters and headers are set as follows id is set to 12345 key is set to userstartuppage string is set to "admin" put /2022/06/rest/self/users/12345/profile/userstartuppage 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 7 this is the example request body "admin" success response \201\ returns this status code if the property value is defined for first time \204\ returns this status code if the property already exists and has been updated failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ either the request is malformed and therefore invalid, or the specified user profile property key is reserved or longer than 62 characters \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \412\ precondition failed (the resource changed since the time specified in the “if unmodified since” header value) \413\ the length of the specified user profile property exceeds the 64kb limit \415\ the server cannot accept the data representation that you sent (as specified in the "content type" header) \5xx\ any 500 code is an internal server error delete /self/users/{id}/profile/{key}/ removes a specified property from a user profile required scope token bsn api self users profile update segments id \int \ the unique identifier for a user key \string \ the name of the profile property request example the example request parameters and headers are set as follows id is set to 12345 key is set to new key 1 delete /2022/06/rest/self/users/12345/profile/new%20key%201 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\ the specified property has been removed from the user profile failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \412\ precondition failed (the resource changed since the time specified in the “if unmodified since” header value) \5xx\ any 500 code is an internal server error get /self/users/{id}/permissions/ returns the permissions granted to a given user required scope token bsn api self users retrieve segment id \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/self/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\ returns the paged list of permission docid\ jwfymc42cdrg5jy2skysu entities granted to a specific user example \[ { "entityid" 12345, "operationuid" "67b9b0ab fb5f 36c4 d598 a71aa8998e4e", "principal" { "login" "johndoe\@brightsign biz", "type" "user", "id" 12345 }, "isfixed" true, "isinherited" false, "isallowed" true, "creationdate" "2020 08 17t20 49 48 353z" } ] failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error get /self/users/{id}/role/permissions/ returns permissions granted to a given user required scope token bsn api self roles retrieve segment id \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/self/users/12345/role/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\ returns the array of permission docid\ jwfymc42cdrg5jy2skysu entities granted to a specific role example \[ { "entityid" null, "operationuid" "b41ac545 d505 7014 edde 51bc4c0d21a0", "principal" { "name" "customrole", "iscustom" true, "type" "role", "id" 12345 }, "isfixed" false, "isinherited" false, "isallowed" true, "creationdate" "2020 08 17t20 49 45 793z" } ] failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error get /self/users/{id}/notifications/ returns the user notification settings required scope token bsn api self users notifications retrieve segment id \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/self/users/12345/notifications/ 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\ returns information about whether each setting in user notification settings entity docid\ suanih9yxgtuvggqi59l5 is enabled or disabled example { "networksuspendingnotificationenabled" false, "networksuspendingnotificationtemplate" null, "networksuspendednotificationenabled" true, "networksuspendednotificationtemplate" null, "networksubscriptionupgradednotificationenabled" true, "networksubscriptionupgradednotificationtemplate" null, "networktrialperiodstartednotificationenabled" true, "networktrialperiodstartednotificationtemplate" null, "networktrialperiodexpiringnotificationenabled" true, "networktrialperiodexpiringnotificationtemplate" null, "networktrialperiodexpirednotificationenabled" true, "networktrialperiodexpirednotificationtemplate" null, "devicefailurenotificationenabled" false, "devicefailurenotificationtemplate" null, "devicesfailurenotificationenabled" false, "devicesfailurenotificationtemplate" null, "devicedisconnectednotificationenabled" false, "devicedisconnectednotificationtemplate" null, "devicesdisconnectednotificationenabled" false, "devicesdisconnectednotificationtemplate" null, "subscriptioncreatednotificationenabled" false, "subscriptioncreatednotificationtemplate" null, "subscriptionscreatednotificationenabled" false, "subscriptionscreatednotificationtemplate" null, "subscriptionqueuednotificationenabled" false, "subscriptionqueuednotificationtemplate" null, "subscriptionsqueuednotificationenabled" false, "subscriptionsqueuednotificationtemplate" null, "gracesubscriptionexpiringnotificationenabled" false, "gracesubscriptionexpiringnotificationtemplate" null, "gracesubscriptionsexpiringnotificationenabled" false, "gracesubscriptionsexpiringnotificationtemplate" null, "demosubscriptionexpiringnotificationenabled" false, "demosubscriptionexpiringnotificationtemplate" null, "demosubscriptionsexpiringnotificationenabled" false, "demosubscriptionsexpiringnotificationtemplate" null, "subscriptionexpiringnotificationenabled" false, "subscriptionexpiringnotificationtemplate" null, "subscriptionsexpiringnotificationenabled" false, "subscriptionsexpiringnotificationtemplate" null, "subscriptionexpirednotificationenabled" false, "subscriptionexpirednotificationtemplate" null, "subscriptionsexpirednotificationenabled" false, "subscriptionsexpirednotificationtemplate" null, "subscriptionsuspendingnotificationenabled" false, "subscriptionsuspendingnotificationtemplate" null, "subscriptionssuspendingnotificationenabled" false, "subscriptionssuspendingnotificationtemplate" null, "subscriptionsuspendednotificationenabled" true, "subscriptionsuspendednotificationtemplate" null, "subscriptionssuspendednotificationenabled" true, "subscriptionssuspendednotificationtemplate" null } failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error put /self/users/{id}/notifications/ updates the user notification settings required scope token bsn api self users notifications update segment id \int \ a unique identifier for a user request body the user notification settings entity docid\ suanih9yxgtuvggqi59l5 request example the example request parameters and headers are set as follows id is set to 12345 put /2022/06/rest/self/users/12345/notifications/ 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 2799 this is the example request body { "networksuspendingnotificationenabled" false, "networksuspendingnotificationtemplate" null, "networksuspendednotificationenabled" true, "networksuspendednotificationtemplate" null, "networksubscriptionupgradednotificationenabled" true, "networksubscriptionupgradednotificationtemplate" null, "networktrialperiodstartednotificationenabled" true, "networktrialperiodstartednotificationtemplate" null, "networktrialperiodexpiringnotificationenabled" true, "networktrialperiodexpiringnotificationtemplate" null, "networktrialperiodexpirednotificationenabled" true, "networktrialperiodexpirednotificationtemplate" null, "devicefailurenotificationenabled" false, "devicefailurenotificationtemplate" null, "devicesfailurenotificationenabled" false, "devicesfailurenotificationtemplate" null, "devicedisconnectednotificationenabled" false, "devicedisconnectednotificationtemplate" null, "devicesdisconnectednotificationenabled" false, "devicesdisconnectednotificationtemplate" null, "subscriptioncreatednotificationenabled" false, "subscriptioncreatednotificationtemplate" null, "subscriptionscreatednotificationenabled" false, "subscriptionscreatednotificationtemplate" null, "subscriptionqueuednotificationenabled" false, "subscriptionqueuednotificationtemplate" null, "subscriptionsqueuednotificationenabled" false, "subscriptionsqueuednotificationtemplate" null, "gracesubscriptionexpiringnotificationenabled" false, "gracesubscriptionexpiringnotificationtemplate" null, "gracesubscriptionsexpiringnotificationenabled" false, "gracesubscriptionsexpiringnotificationtemplate" null, "demosubscriptionexpiringnotificationenabled" false, "demosubscriptionexpiringnotificationtemplate" null, "demosubscriptionsexpiringnotificationenabled" false, "demosubscriptionsexpiringnotificationtemplate" null, "subscriptionexpiringnotificationenabled" false, "subscriptionexpiringnotificationtemplate" null, "subscriptionsexpiringnotificationenabled" false, "subscriptionsexpiringnotificationtemplate" null, "subscriptionexpirednotificationenabled" false, "subscriptionexpirednotificationtemplate" null, "subscriptionsexpirednotificationenabled" false, "subscriptionsexpirednotificationtemplate" null, "subscriptionsuspendingnotificationenabled" false, "subscriptionsuspendingnotificationtemplate" null, "subscriptionssuspendingnotificationenabled" false, "subscriptionssuspendingnotificationtemplate" null, "subscriptionsuspendednotificationenabled" true, "subscriptionsuspendednotificationtemplate" null, "subscriptionssuspendednotificationenabled" true, "subscriptionssuspendednotificationtemplate" null } success response \204\ the specified user notification settings have been updated on the network failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \415\ the server cannot accept the data representation that you sent (as specified in the "content type" header) \5xx\ any 500 code is an internal server error get /self/applications/ returns pages of applications registered by an authenticated person, based on the filtering specified, in order of the specified sort query required scope token bsn api self applications retrieve query string parameters filter \string\ \optional \ an expression docid 3l0afyd3xooe ytvfk2vs for filtering search results the default value is null sort \string\ \optional \ an expression for sorting the search results the default value is null the sort expression specifies the entry used for sorting and the ascending/descending (asc/desc) sorting order (e g "\[application] \[name] asc") marker \string\ \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 application instances exceeds the pagesize this parameter is only required if you need more elements in the paged list than the pagesize (100) pagesize \int\ \optional \ the maximum number of application 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 filter is set to \[clientid] is '3fde8d97 2e40 4b0b a76f 445804824799' sort is set to \[lastmodifieddate] asc get https //api bsn cloud/2022/06/rest/self/applications/?filter=%5bclientid%5d%20is%20%273fde8d97 2e40 4b0b a76f 445804824799%27\&sort=%5blastmodifieddate%5d%20asc\&pagesize=1 http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/problem+json accept encoding gzip,br success response with body \200\ returns a paged list of application entity docid\ vdsymhqxz vzamklkeug7 example this is an example of a 200 level response { "items" \[ { "id" 12345, "owner" { "id" 54321, "login" "janedoe\@brightsign biz" }, "clientid" "3fde8d97 2e40 4b0b a76f 445804824799", "clientsecret" null, "scope" "self info main content upload", "name" "my application", "description" "sample application", "creationdate" "2025 02 10t22 32 59 830z", "lastmodifieddate" "2025 02 10t22 32 59 830z" } ], "totalitemcount" 3, "matchingitemcount" 1, "pagesize" 1, "prevmarker" "mjayns0wmi0xmfqymjozmjo1os44mzbaldm5lhbyzxy=", "nextmarker" "mjayns0wmi0xmfqymjozmjo1os44mzbaldm5lg5lehq=", "istruncated" false, "sortexpression" "\[lastmodifieddate] asc", "filterexpression" "\[clientid] is '3fde8d97 2e40 4b0b a76f 445804824799'" } failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error get /self/applications/scopes/ retrieves the list of available scope tokens which can be granted to a new or existing application request example the example request parameters and headers are set as follows get /2022/06/rest/self/applications/scopes/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/problem+json accept encoding gzip,br success response body \200\ returns the list of available oauth2 scope tokens example \[ "self applications", "self applications create", "self applications delete", "self applications retrieve", "self applications update", "self info", "self info retrieve", "self info update", "self networks", "self networks create", "self networks retrieve", "self networks update", "self profile", "self profile retrieve", "self profile update", "self roles", "self roles retrieve", "self token", "self token revoke", "self token validate", "self users", "self users notifications retrieve", "self users notifications update", "self users profile retrieve", "self users profile update", "self users retrieve" ] failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error post /self/applications/ registers a new application to obtain oauth2 client credentials required scope token bsn api self applications create request body the application entity docid\ vdsymhqxz vzamklkeug7 request example the example request parameters and headers are set as follows post /2022/06/rest/self/applications/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} content type application/json content length 269 accept application/json, application/problem+json accept encoding gzip,br this is the example request body { "id" 0, "name" "my application", "description" "sample application", "owner" null, "scope" "self info main content upload", "clientid" "", "clientsecret" null, "creationdate" "0001 01 01t00 00 00", "lastmodifieddate" "0001 01 01t00 00 00" } success response body \201\ returns the application entity docid\ vdsymhqxz vzamklkeug7 example { "id" 12345, "owner" { "id" 54321, "login" "janedoe\@brightsign biz" }, "clientid" "3fde8d97 2e40 4b0b a76f 445804824799", "clientsecret" "echcvgtkzoex3ptkbgxq2upmkmcqvxl7", "scope" "self info main content upload", "name" "my application", "description" "sample application", "creationdate" "2025 02 10t22 32 59 828z", "lastmodifieddate" "2025 02 10t22 32 59 828z" } failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \415\ the server cannot accept the data representation that you sent (as specified in the "content type" header) \5xx\ any 500 code is an internal server error delete /self/applications/ unregisters the existing unused "application" instances which are registered by an authenticated “person” and satisfy the specified filter criteria, and revokes the related oauth2 client credentials required scope token bsn api self applications delete query string parameters filter \string\ \required \ an expression docid 3l0afyd3xooe ytvfk2vs for filtering search results the default value is null request example the example request parameters and headers are set as foll ow s filter is set to \[creationdate] is before '2025 01 01' delete /2022/06/rest/self/applications/?filter=%5bcreationdate%5d%20is%20before%20%272025 01 01%27 http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/problem+json accept encoding gzip,br success response body \200\ the number of removed entities is returned failure \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error get /self/applications/count/ returns the number of application instances which are registered to an authenticated person and satisfy the specified filter criteria required scope token bsn api main applications retrieve query string parameters filter \string\ \optional \ an expression docid 3l0afyd3xooe ytvfk2vs for filtering search results the default value is null request example the example request parameters and headers are set as follows filter is set to \[creationdate] is before '2025 01 01' get /2022/06/rest/self/applications/count/?filter=%5bcreationdate%5d%20is%20before%20%272025 01 01%27 http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/problem+json accept encoding gzip,br success response body \200\ the applications count is returned as an integer value failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error get /self/applications/{id}/ returns information about an “application” registered by an authenticated “person” and having the specified “id” required scope token bsn api self applications retrieve segment id \string \ the unique identifier of the application request example the example request parameters and headers are set as follows id is set to 12345 get /2022/06/rest/self/applications/12345/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/problem+json accept encoding gzip,br if modified since thu, 06 jun 2024 17 32 38 gmt success response with body \200\ returns the application entity docid\ vdsymhqxz vzamklkeug7 this is an example of a 200 level response { "id" 12345, "owner" { "id" 54321, "login" "janedoe\@brightsign biz" }, "clientid" "3fde8d97 2e40 4b0b a76f 445804824799", "clientsecret" null, "scope" "self info main content upload", "name" "my application", "description" "sample application", "creationdate" "2025 02 10t22 32 59 828z", "lastmodifieddate" "2025 02 10t22 32 59 828z" } \304\ the resource was not modified since the time specified in the “if modified since” header failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \5xx\ any 500 code is an internal server error put /self/applications/{id}/ edits information about an application which has a specified id required scope token bsn api main applications update segment id \int \ a unique identifier for an application request body the application entity docid\ vdsymhqxz vzamklkeug7 request example the example request parameters and headers are set as follows id is 12345 put /2022/06/rest/self/applications/12345/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} content type application/json content length 269 accept application/json, application/problem+json accept encoding gzip,br if unmodified since thu, 06 jun 2024 17 32 38 gmt this is the example request body { "id" 0, "name" "my application", "description" "sample application", "owner" null, "scope" "self info main content upload", "clientid" "", "clientsecret" null, "creationdate" "0001 01 01t00 00 00", "lastmodifieddate" "0001 01 01t00 00 00" } success response \204\ the specified application has been updated on the network failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \412\ precondition failed (the resource/application changed since the time specified in the “if unmodified since” header value) \415\ the server cannot accept the data representation that you sent (as specified in the "content type" header) \5xx\ any 500 code is an internal server error delete /self/applications/{id}/ unregisters the existing unused “application” instance registered by an authenticated “person” and having the specified “id”, and revokes the related oauth2 client credentials required scope token bsn api self applications delete segment id \string \ the unique identifier of the application request example the example request parameters and headers are set as follows id is set to 12345 delete /2022/06/rest/self/applications/12345/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/problem+json accept encoding gzip,br if unmodified since thu, 06 jun 2024 17 32 38 gmt success response \204\ the specified application has been removed failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request is malformed and therefore invalid, or it is rejected in accordance with the business rules for example, application service users may exist for this application and must be removed before it can be deleted \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the server cannot find the requested resource (the path does not exist) \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \412\ precondition failed (the resource changed since the time specified in the “if unmodified since” header value) \5xx\ any 500 code is an internal server error post /self/applications/{id}/secret/ rotates the oauth2 client secret of an existing “application” instance registered by an authenticated “person” and having the specified “id” see this page https //stackoverflow\ com/questions/75571740/how to create keyclock clientsecret via api required scope token bsn api self applications update request example the example request parameters and headers are set as follows id is set to 12345 post /2022/06/rest/self/applications/12345/secret/ http/1 1 host api bsn cloud connection keep alive authorization bearer {{useraccesstoken}} accept application/json, application/problem+json accept encoding gzip,br if unmodified since thu, 06 jun 2024 17 32 38 gmt success response body \200\ invalidates the current oauth2 client secret and issues a new one for a given application example "jqvhz360hrnymsu45yx25n8tvngwxzcb" failure response \300\ the requested representation could not be returned because it is ambiguous (there are multiple requested representations) \400\ the request or request body is malformed and therefore invalid, or it is rejected in accordance with the business rules \401\ the access token is invalid or not specified \403\ the supplied access token, though valid, doesn't provide access to this method \404\ the referenced application cannot be found \406\ the server cannot return the data representation that you requested (as specified in the "accept" header) \412\ precondition failed (the resource/group changed since the time specified in the “if unmodified since” header value) \5xx\ any 500 code is an internal server error