Users Endpoints (2020/10)

these endpoints enable management of users on a network a user is an instance of a person that is associated with a single network (there can only be one person, but there can be 0 to an infinite number of users on a network) base url for these endpoints https //api bsn cloud/2020/10/rest/users get / returns a list of user instances on a network required scope token bsn api main users retrieve query string parameters marker string string optional optional a value specifying which page to retrieve this value is useful if the istruncated entry in the response body of the previous get call indicates that the number of user instances exceeds the pagesize this parameter is only required if you need more elements in the paged list than the pagesize (100) pagesize int int optional optional the maximum number of user instances that can be contained in the response body this defaults to the maximum allowed page size (100) response success response body 200 200 returns a paged list entity (2020/10) docid\ joielmbbiwrnzeqzvpqqa of user entity (2020/10) docid\ jirqabyicrjavih3z4zeq instances on a network this will return not more than 100 entities along with the information necessary to return any other remaining pages 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 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error post / creates a user instance on a network required scope token bsn api main users create request body the user entity (2020/10) docid\ jirqabyicrjavih3z4zeq response success response body 201 201 returns the user entity (2020/10) docid\ jirqabyicrjavih3z4zeq created and referenced by the uri (given by the location header field) in the response 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) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error get /{login}/ returns information for a specified user on a network required scope token bsn api main users retrieve segment login string string the login information of the user response success response with body 200 200 returns the user entity (2020/10) docid\ jirqabyicrjavih3z4zeq success response 304 304 the resource was not modified since the time specified in the “if modified since” header 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 path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error put /{login}/ updates information for a specified user on a network required scope token bsn api main users update segment login string string the login information of the user request body the user entity (2020/10) docid\ jirqabyicrjavih3z4zeq response success 204 204 the user information has been updated 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete /{login}/ deletes the specified user on a network required scope token bsn api main users delete segment login string string the login information of the user response success 204 204 the specified user information was successfully deleted 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 path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 5xx 5xx any 500 code is an internal server error get /{id\ int}/ returns information for a specified user on a network required scope token bsn api main users retrieve segment id int int a unique identifier for a user response success response with body 200 200 returns the user entity (2020/10) docid\ jirqabyicrjavih3z4zeq success response 304 304 the resource was not modified since the time specified in the “if modified since” header 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 path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error put /{id\ int}/ update the given user instance required scope token bsn api main users update segment id int int a unique identifier for a user request body the user entity (2020/10) docid\ jirqabyicrjavih3z4zeq response success 204 204 the user information has been updated 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 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete /{id\ int}/ deletes information for a specified user on a network required scope token bsn api main users delete segment id int int a unique identifier for a user response success 204 204 the specified user information was successfully deleted 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 path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 5xx 5xx any 500 code is an internal server error get /operations/ returns the operational permissions granted to roles for specific business operations required scope token bsn api main operations retrieve response success response body 200 200 returns the business operations entity (2020/10) docid\ ychro4ocgshfhae1gvygf 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 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{id\ int}/permissions/ returns object permissions for a given user instance required scope token bsn api main users retrieve segment id int int a unique identifier for a user response success response body 200 200 returns an array of permission entity (2020/10) docid 9p ncidl9xh7qdpkxgodl entities 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 path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error post /{id\ int}/permissions/ adds permissions for a specified user on a network required scope token bsn api main users update segment id int int a unique identifier for a user request body an array of permission entity (2020/10) docid 9p ncidl9xh7qdpkxgodl entities response success 204 204 the permissions were successfully added to the specified user instance failure 400 400 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 404 404 the server cannot find the requested resource (the path does not exist) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete /{id\ int}/permissions/ removes permissions for a specified user on a network required scope token bsn api main users update segment id int int a unique identifier for a user request body an array of permission entity (2020/10) docid 9p ncidl9xh7qdpkxgodl entities response success 204 204 the specified user permissions were successfully deleted failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{login}/permissions/ returns object permissions for a given user instance required scope token bsn api main users retrieve segment login string string the login information of the user response success response body 200 200 returns an array of permission entity (2020/10) docid 9p ncidl9xh7qdpkxgodl entities 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 path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error post /{login}/permissions/ adds permissions for a specified user on a network required scope token bsn api main users update segment login string string the login information of the user request body an array of permission entity (2020/10) docid 9p ncidl9xh7qdpkxgodl entities response success 204 204 the permissions were successfully added to the specified user instance failure 400 400 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 404 404 the server cannot find the requested resource (the path does not exist) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete /{login}/permissions/ removes permissions for a specified user on a network required scope token bsn api main users update segment login string string the login information of the user request body an array of permission entity (2020/10) docid 9p ncidl9xh7qdpkxgodl entities response success 204 204 the specified user permissions were successfully deleted failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request or request body is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource (the path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{id\ int}/tokens/{token}/ validates the the user access or refresh token granted to the specified user required scope token bsn api main users token validate segments id int int a unique identifier for a user token string string a user access or refresh token for a bsn cloud network response success response body 200 200 returns the token info entity (2020/10) docid 0x0nmgjzaehzv5yrqeyxr 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 path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error delete /{id\ int}/tokens/{token}/ revokes user access or refresh tokens for the specified user required scope token bsn api main users token revoke segments id int int a unique identifier for a user token string string the user access or refresh token to use with this endpoint call response success 204 204 the user access or refresh token has been successfully revoked from the specified user failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the 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 404 404 either the specified token is invalid, expired, or revoked, or it is issued for another user 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{login}/tokens/{token}/ validates the user access or refresh token granted to the specified user required scope token bsn api main users token validate segments login int int the login for the user token string string a user access or refresh token for a bsn cloud network response success response body 200 200 returns the token info entity (2020/10) docid 0x0nmgjzaehzv5yrqeyxr 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 path does not exist) 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error delete /{login}/tokens/{token}/ revokes the user access or refresh token granted to the specified user required scope token bsn api main users token revoke segments login int int the login for the user token string string a user access or refresh token for a bsn cloud network response success 204 204 the user access or refresh token has been successfully revoked from the specified user 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 either the specified token is invalid, expired, or revoked, or it is issued for another user 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error