Provisioning Endpoints (2020/10)

7 min

the provisioning resources allow users to setup players or change player setups base url for this endpoint https //api bsn cloud/2020/10/rest/provisioning post /setups/tokens/ issues a token which allows you to register players in the current network required scope token bsn api main devices setups token create request body a token info entity (2020/10) docid 0x0nmgjzaehzv5yrqeyxr request example the example request parameters and headers are set as follows post /2020/10/rest/provisioning/setups/tokens/ 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 there is no request body since the required information is passed in the url response success 200 200 a setup token has been issued for players on the specified network example { "token" {{token}}, "scope" "cert", "validfrom" "2024 05 21t00 00 00z", "validto" "2024 11 17t00 00 00z" } failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 either the request or request body 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 /setups/tokens/{token}/ validates a player setup token on the current network and retrieves its metadata required scope token bsn api main devices setups token validate segment token string string an oauth2 token for player registration in the current network request example the example request parameters and headers are set as follows token is set to {{token}} get /2020/10/rest/provisioning/setups/tokens/{{token}}/ 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 response success 200 200 returns a token info entity (2020/10) docid 0x0nmgjzaehzv5yrqeyxr example { "token" {{token}}, "scope" "cert", "validfrom" "2024 05 16t16 36 04 000z", "validto" "2026 05 16t16 36 04 000z" } failure 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 token is expired or invalid) 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 /setups/tokens/{token}/ revokes a player setup token on the current network required scope token bsn api main devices setups token revoke segment token string string an oauth2 token for player registration in the current network request example the example request parameters and headers are set as follows token is set to {{token}} delete /2020/10/rest/provisioning/setups/tokens/{{token}}/ 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 response success response body 204 204 the player setup token has been revoked failure 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 token is expired or invalid) 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