Page Comparison

These endpoints enable management of users on a network. A user is an instance of a person that is associated with a single network (there can only be one person, but there can be 0 to an infinite number of users on a network).

Base URL for these endpoints: https://api.bsn.cloud/2022/06/REST/Users

_________________________________________________________________________

GET /

Returns a list of user instances on a network

...

bsn.api.main.users.retrieve

______________________________________________________________

Query String Parameters

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 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 optional

The maximum number of user instances that can be contained in the response body. This defaults to the maximum allowed page size (100).

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

...

Code Block

GET /2022/06/REST/Users/?marker=RY0JlZW4tWW3hcnMsMTcyMU4&pageSize=1 HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate

______________________________________________________________

Success Response Body

200: Returns a paged list of User Entity instances on a network. This will return not more than 100 entities along with the information necessary to return any other remaining pages.

...

Code Block

language	json

{
   "items": [   {
      "id": 12345,
      "person":       {
         "id": 1234,
         "login": "JohnDoe@look.biz",
         "password": null,
         "firstName": "John",
         "lastName": "Doe",
         "creationDate": "2020-07-09T19:05:20.247Z",
         "lastModifiedDate": "2023-11-29T17:40:54.403Z",
         "activationDate": "2020-07-09T19:05:38.723Z"
      },
      "description": "Network Administrator",
      "creationDate": "2020-07-09T19:09:04.98Z",
      "lastModifiedDate": "2020-08-17T20:49:48.377Z",
      "lastLoginDate": "2024-01-03T17:55:26.17Z",
      "isLockedOut": false,
      "lastLockoutDate": null,
      "roleName": "Administrators",
      "permissions":       [
                  {
            "entityId": 123456,
            "operationUID": "67b9b0ab-fb5f-36c4-d598-a71aa8998e4e",
            "principal":             {
               "login": "JohnDoe@look.biz",
               "type": "User",
               "id": 12345
            },
            "isFixed": true,
            "isInherited": false,
            "isAllowed": true,
            "creationDate": "2020-08-17T20:49:48.353Z"
         }
      ]
   }],
   "totalItemCount": 2,
   "matchingItemCount": 2,
   "pageSize": 1,
   "nextMarker": "F32RY0JlZW4tWW3hcnMuMTcy00",
   "isTruncated": false,
   "sortExpression": "[User].[Person].[Login] ASC",
   "filterExpression": ""
}

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

...

bsn.api.main.users.create

______________________________________________________________

Request Body

The User Entity

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

...

Code Block

language	json

{
  "id": 0,
  "person": {
    "id": 0,
    "login": "JohnDoe@host.com",
    "password": null,
    "firstName": "John",
    "lastName": "Doe",
    "creationDate": "0001-01-01T00:00:00",
    "lastModifiedDate": "0001-01-01T00:00:00",
    "activationDate": null
  },
  "description": "Supervisor",
  "creationDate": "0001-01-01T00:00:00",
  "lastLoginDate": null,
  "isLockedOut": false,
  "lastLockoutDate": null,
  "roleName": "Viewers",
  "permissions": []
}

______________________________________________________________

Success Response Body

201: Returns the User Entity created and referenced by the Uri (given by the Location header field) in the response.

...

bsn.api.main.users.retrieve

______________________________________________________________

Segment

login string

The login information of the user

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

...

Code Block

GET /2022/06/REST/Users/JaneDoe%40brightsign.biz/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Modified-Since: Wed, 20 Dec 2023 21:32:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate

______________________________________________________________

Success Response with Body

...

Code Block

language	json

{
   "id": 123456,
   "person":    {
      "id": 12345,
      "login": "JaneDoe@brightsign.biz",
      "password": null,
      "firstName": "Jane",
      "lastName": "Doe",
      "creationDate": "2020-07-09T19:05:20.247Z",
      "lastModifiedDate": "2020-08-17T20:49:48.377Z",
      "activationDate": "2020-07-09T19:05:38.723Z"
   },
   "description": "Network Administrator",
   "creationDate": "2020-07-09T19:09:04.98Z",
   "lastModifiedDate": "2023-12-20T21:32:35.093Z",
   "lastLoginDate": "2024-01-03T19:05:23.98Z",
   "isLockedOut": false,
   "lastLockoutDate": null,
   "roleName": "Administrators",
   "permissions":    [
            {
         "entityId": 123456,
         "operationUID": "67b9b0ab-fb5f-36c4-d598-a71aa8998e4e",
         "principal":          {
            "login": "JaneDoe@brightsign.biz",
            "type": "User",
            "id": 12345
         },
         "isFixed": true,
         "isInherited": false,
         "isAllowed": true,
         "creationDate": "2020-08-17T20:49:48.353Z"
      }
   ]
}

Success Response

304: The resource was not modified since the time specified in the “If-Modified-Since” header

...

bsn.api.main.users.update

______________________________________________________________

Segment

login string

The login information of the user

______________________________________________________________

Request Body

The User Entity

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

...

Code Block

language	json

{
   "id": 123456,
   "person":    {
      "id": 12345,
      "login": "JaneDoe@brightsign.biz",
      "password": null,
      "firstName": "Jane",
      "lastName": "Doe",
      "creationDate": "0001-01-01T00:00:00",
      "lastModifiedDate": "0001-01-01T00:00:00",
      "activationDate": "0001-01-01T00:00:00"
   },
   "description": "Network Administrator",
   "creationDate": "0001-01-01T00:00:00",
   "lastModifiedDate": "0001-01-01T00:00:00",
   "lastLoginDate": "0001-01-01T00:00:00",
   "isLockedOut": false,
   "lastLockoutDate": null,
   "roleName": "Administrators",
   "permissions":    [
            {
         "entityId": 123456,
         "operationUID": "67b9b0ab-fb5f-36c4-d598-a71aa8998e4e",
         "principal":          {
            "login": "JaneDoe@brightsign.biz",
            "type": "User",
            "id": 12345
         },
         "isFixed": false,
         "isInherited": false,
         "isAllowed": true,
         "creationDate": "0001-01-01T00:00:00"
      }
   ]
}

______________________________________________________________

Success Response

204: The user information has been updated

...

bsn.api.main.users.delete

______________________________________________________________

Segment

login string

The login information of the user

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

...

Code Block

DELETE /2022/06/REST/Users/JohnDoe%40host.com/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Unmodified-Since: Wed, 20 Dec 2023 21:32:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate

______________________________________________________________

Success Response

204: The specified user information was successfully deleted

...

bsn.api.main.users.retrieve

______________________________________________________________

Segment

id int

A unique identifier for a user

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

...

Code Block

GET /2022/06/REST/Users/12345/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Modified-Since: Wed, 20 Dec 2023 21:32:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate

______________________________________________________________

Success Response with Body

...

Code Block

language	json

{
   "id": 12345,
   "person":    {
      "id": 12345,
      "login": "JaneDoe@brightsign.biz",
      "password": null,
      "firstName": "Jane",
      "lastName": "Doe",
      "creationDate": "2020-07-09T19:05:20.247Z",
      "lastModifiedDate": "2023-11-29T17:40:54.403Z",
      "activationDate": "2020-07-09T19:05:38.723Z"
   },
   "description": "Network Administrator",
   "creationDate": "2020-07-09T19:09:04.98Z",
   "lastModifiedDate": "2020-08-17T20:49:48.377Z",
   "lastLoginDate": "2024-01-03T19:05:23.98Z",
   "isLockedOut": false,
   "lastLockoutDate": null,
   "roleName": "Administrators",
   "permissions":    [
            {
         "entityId": 123456,
         "operationUID": "67b9b0ab-fb5f-36c4-d598-a71aa8998e4e",
         "principal":          {
            "login": "JaneDoe@brightsign.biz",
            "type": "User",
            "id": 12345
         },
         "isFixed": true,
         "isInherited": false,
         "isAllowed": true,
         "creationDate": "2020-08-17T20:49:48.353Z"
      }
   ]
}

Success Response

304: The resource was not modified since the time specified in the “If-Modified-Since” header

...

bsn.api.main.users.update

______________________________________________________________

Segment

id int

A unique identifier for a user

______________________________________________________________

Request Body

The User Entity

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

...

Code Block

language	json

{
   "id": 12345,
   "person":    {
      "id": 12345,
      "login": "JaneDoe@brightsign.biz",
      "password": null,
      "firstName": "Jane",
      "lastName": "Doe",
      "creationDate": "0001-01-01T00:00:00",
      "lastModifiedDate": "0001-01-01T00:00:00",
      "activationDate": "0001-01-01T00:00:00"
   },
   "description": "Network Administrator",
   "creationDate": "0001-01-01T00:00:00",
   "lastModifiedDate": "0001-01-01T00:00:00",
   "lastLoginDate": "0001-01-01T00:00:00",
   "isLockedOut": false,
   "lastLockoutDate": null,
   "roleName": "Administrators",
   "permissions":    [
            {
         "entityId": 123456,
         "operationUID": "67b9b0ab-fb5f-36c4-d598-a71aa8998e4e",
         "principal":          {
            "login": "JaneDoe@brightsign.biz",
            "type": "User",
            "id": 12345
         },
         "isFixed": false,
         "isInherited": false,
         "isAllowed": true,
         "creationDate": "0001-01-01T00:00:00"
      }
   ]
}

______________________________________________________________

Success Response

204: The user information has been updated

...

bsn.api.main.users.delete

______________________________________________________________

Segment

id int

A unique identifier for a user

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

...

Code Block

DELETE /2022/06/REST/Users/12345/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Unmodified-Since: Wed, 20 Dec 2023 21:32:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate

______________________________________________________________

Success Response

204: The specified user information was successfully deleted

...

bsn.api.main.operations.retrieve

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

Code Block

GET /2022/06/REST/Users/Operations/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate

______________________________________________________________

Success Response Body

200: Returns theBusiness Operations Entity

...

bsn.api.main.users.retrieve

______________________________________________________________

Segment

id int

A unique identifier for a user

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

...

Code Block

GET /2022/06/REST/Users/12345/Permissions/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate

______________________________________________________________

Success Response Body

200: Returns an array of Permission entities

...

bsn.api.main.users.update

______________________________________________________________

Segment

id int

A unique identifier for a user

______________________________________________________________

Request Body

An array of Permission entities

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

...

Code Block

language	json

[
  {
    "entityId": 54321,
    "operationUID": "c978aa8d-c7ac-410f-aec3-22e136d0ba58",
    "principal": {
      "login": "JaneDoe@brightsign.biZ",
      "type": "User",
      "id": 12345
    },
    "isFixed": false,
    "isInherited": false,
    "isAllowed": true,
    "creationDate": "0001-01-01T00:00:00"
  }
]

______________________________________________________________

Success Response

204: The permissions were successfully added to the specified user instance

...

bsn.api.main.users.update

______________________________________________________________

Segment

id int

A unique identifier for a user

______________________________________________________________

Request Body

An array of Permission entities

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

...

Code Block

language	json

[
  {
    "entityId": 54321,
    "operationUID": "39e69897-8d9a-f634-95cf-7419a3e93c23",
    "principal": {
      "login": "JaneDoe@brightsign.biZ",
      "type": "User",
      "id": 12345
    },
    "isFixed": false,
    "isInherited": false,
    "isAllowed": true,
    "creationDate": "0001-01-01T00:00:00"
  }
]

______________________________________________________________

Success Response

204: The specified user permissions were successfully deleted

...

bsn.api.main.users.retrieve

______________________________________________________________

Segment

login string

The login information of the user

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

...

Code Block

GET /2022/06/REST/Users/JohnDoe%40brightsign.biz/Permissions/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate

______________________________________________________________

Success Response Body

200: Returns an array of Permission entities

...

bsn.api.main.users.update

______________________________________________________________

Segment

login string

The login information of the user

______________________________________________________________

Request Body

An array of Permission entities

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

...

Code Block

language	json

[
  {
    "entityId": 54321,
    "operationUID": "c978aa8d-c7ac-410f-aec3-22e136d0ba58",
    "principal": {
      "login": "JohnDoe@brightsign.biZ",
      "type": "User",
      "id": 12345
    },
    "isFixed": false,
    "isInherited": false,
    "isAllowed": true,
    "creationDate": "0001-01-01T00:00:00"
  }
]

______________________________________________________________

Success Response

204: The permissions were successfully added to the specified user instance

...

bsn.api.main.users.update

______________________________________________________________

Segment

login string

The login information of the user

______________________________________________________________

Request Body

An array of Permission entities

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

...

Code Block

language	json

[
  {
    "entityId": 54321,
    "operationUID": "39e69897-8d9a-f634-95cf-7419a3e93c23",
    "principal": {
      "login": "JohnDoe@brightsign.biZ",
      "type": "User",
      "id": 12345
    },
    "isFixed": false,
    "isInherited": false,
    "isAllowed": true,
    "creationDate": "0001-01-01T00:00:00"
  }
]

______________________________________________________________

Success Response

204: The specified user permissions were successfully deleted

...

bsn.api.main.users.token.validate

______________________________________________________________

Segments

id int

A unique identifier for a user

token string

A user access or refresh token for a BSN.cloud network

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

...

Code Block

GET /2022/06/REST/Users/12345/Tokens/{{UserAccessToken}}/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate

______________________________________________________________

Success Response Body

200: Returns theToken Info Entity

...

bsn.api.main.users.token.revoke

______________________________________________________________

Segments

id int

A unique identifier for a user

token string

The user access or refresh token to use with this endpoint call

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

...

Code Block

DELETE /2022/06/REST/Users/12345/Tokens/{{UserAccessToken}}/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate

______________________________________________________________

Success Response

204: The user access or refresh token has been successfully revoked from the specified user

...

bsn.api.main.users.token.validate

______________________________________________________________

Segments

login string

The login for a user

token string

A user access or refresh token for a BSN.cloud network

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

...

Code Block

GET /2022/06/REST/Users/JohnDoe%40brightsign.biz/Tokens/{{UserAccessToken}}/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate

______________________________________________________________

Success Response Body

200: Returns theToken Info Entity

...

bsn.api.main.users.token.revoke

______________________________________________________________

Segments

login string

The login for a user

token string

A user access or refresh token for a BSN.cloud network

______________________________________________________________

Request Example

The example request parameters and headers are set as follows:

...

Code Block

DELETE /2022/06/REST/Users/JohnDoe%40brightsign.biz/Tokens/{{UserAccessToken}}/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate

______________________________________________________________

Success Response

204: The user access or refresh token has been successfully revoked from the specified user

...

Versions Compared

Old Version 30

New Version Current

Key

GET /