Users Endpoints (2017/01)

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 brightsignnetwork com/2017/01/rest/users get / returns a list of user instances on a network parameters marker string 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 pagesize int the maximum number of user instances that can be contained in the response body response body returns a paged list entity (2017/01) docid\ yn3gu asyfisjdxgbjdvb of user entity (2017/01) docid\ t8i22gqufe stmwntiebe instances on a network this will return not more than 100 entities along with the information necessary to return any other remaining pages post / creates a user instance on a network request body the user entity (2017/01) docid\ t8i22gqufe stmwntiebe response body returns a 201 status code and the new resource created and referenced by the uri (given by the location header field) in the response the response includes the user entity (2017/01) docid\ t8i22gqufe stmwntiebe get /{login}/ returns information for a specified user on a network parameters login string the login information of the user response body returns the user entity (2017/01) docid\ t8i22gqufe stmwntiebe put /{login}/ updates information for a specified user on a network parameters login string the login information of the user request body the user entity (2017/01) docid\ t8i22gqufe stmwntiebe response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx delete /{login}/ deletes information for a specified user on a network parameters login string the login information of the user response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx get /{id\ int}/ returns information for a specified user on a network parameters id int a unique identifier for a user response body returns the user entity (2017/01) docid\ t8i22gqufe stmwntiebe put /{id\ int}/ update the given user instance parameters id int a unique identifier for a user request body the user entity (2017/01) docid\ t8i22gqufe stmwntiebe response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx delete /{id\ int}/ deletes information for a specified user on a network parameters id int a unique identifier for a user response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx get /operations/ returns the operational permissions granted to roles for specific business operations response body returns the business operations entity (2017/01) docid\ fwdujpp aohpf3res sz get /{id\ int}/permissions/ includes object permissions for a given user instance parameters id int a unique identifier for a user response body returns the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy post /{id\ int}/permissions/ adds permissions for a specified user on a network parameters id int a unique identifier for a user request body the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx delete /{id\ int}/permissions/ removes permissions for a specified user on a network parameters id int a unique identifier for a user request body the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx get /{login}/permissions/ includes object permissions for a given user instance parameter login string the login information of the user response body returns the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy post /{login}/permissions/ adds permissions for a specified user on a network parameter login string the login information of the user request body the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx delete /{login}/permissions/ removes permissions for a specified user on a network parameter login string the login information of the user request body the permission entity (2017/01) docid\ horbsqti93 eafzzftgmy response body on success this method returns a status code 2xx, on failure it returns a status code of 5xx