| Panel | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
ON THIS PAGE
|
...
...
...
...
Parameters
Person: An array of information about a person in the network
Response Body
[int] Id:The user id[string] Login:The user login name[string] Email:The user login email[string] Password:The user password[string] FirstName:The first name of the user[string] LastName:The last name of the user[string] CreationDate:
POST
Registers the user in the current BSN.cloud network. The server will return your person credentials, including an auto-generated password, which Postman will store.
Parameters
[returnURL]This parameter is optional. If it is not specified, the parameters value from BSN configuration file will be used.
Request Body
[int] Id:[string] Login:The user login name[string] Email:The user login email[string] Password:The user password[string] FirstName:The first name of the user[string] LastName:The last name of the user[string] CreationDate:
Response Body
Person
PUT
Updates the users information in the current network.
Request Body
...
...
...
...
...
...
...
...
...
KeyValuePair<string, string>
/self/profile/{key}
GET
Gets the users profile settings.
Response Body
String
PUT
Updates the users profile settings.
Request Body
String
Response Body
[KeyValuePair<string, string>]
DELETE
Deletes the users profile settings.
/self/networks/
GET
Retrieves all networks associated with the user.
Response Body
[int] id:The network id-
[string] name:The name of the network owner [string] creationDate:The creation date of the network[string] lockoutDate:The date on which the user was locked out, if applicable[bool] isLockedOut:Whether the user is locked out[string]lastLockoutDate:The last date on which the user was locked out, if applicablesettings:[string]userAccessTokenLifetime[string] userRefreshTokenLifetime[string] deviceAccessTokenLifetime[string] deviceRefreshTokenLifetime[string] deviceRegistrationTokenLifetime[bool]automaticSubscriptionsManagementEnabled[bool]automaticTaggedPlaylistApprovementEnabled
subscription:[int] id:The subscription id[string] level: Whether the network is "Content" or "Control"[string] creationDate:The creation date of the subscription[string] lastModifiedDate:The last date on which the subscription was modified[string]expireDate:The date on which the network subscription will expire
POST
This call creates a BSN.cloud network: The server will create a network with your credentials as the network owner.
Parameters
key:
Request Body
[int] id:The network id[string] name:The name of the network owner[string] creationDate:The creation date of the network[string] lockoutDate:The date on which the user was locked out, if applicable[bool] isLockedOut:Whether the user is locked out[string]lastLockoutDate:The last date on which the user was locked out, if applicablesettings:[string]userAccessTokenLifetime[string] userRefreshTokenLifetime[string] deviceAccessTokenLifetime[string] deviceRefreshTokenLifetime[string] deviceRegistrationTokenLifetime[bool]automaticSubscriptionsManagementEnabled[bool]automaticTaggedPlaylistApprovementEnabled
subscription
Response BodyNetwork
/self/networks/{networkId}/
/self/networks/{networkName}/
GET
Retrieve the network name.
Request Body
Network
/self/networks/{networkId}/settings/
GET
Retrieve the network settings.
Response Body
Network Settings
/self/networks/{networkName}/settings/
PUT
Request Body
Network Settings
/self/networks/{networkId}/subscription/
/self/networks/{networkName}/subscription/
GET
Gets the network subscription information for the user.
Response Body
Network Subscription
/self/users/
GET
Gets the names of the user(s) on the current network
Response Body
User[]
/self/users/{userId}/
GET
Gets the id(s) of the users on the current network
Response Body
User
/self/users/{userId}/role
GET
Gets the role(s) of the users on the current network
Response Body
Role
If the user is not assigned to a role, then the expected response status is 204 (No content)
/self/users/{userId}/role/permissions
GET
Gets the role permissions of the users on the current network
Response Body
Permission[]Dictionary<string, string>
If the user is not assigned to a role, then the expected response status is 200, with empty array ('[]' in case JSON format) as a body.
/self/users/{userId}/profile/
POST
Request Body
[KeyValuePair<string, string>]
Response Body
[KeyValuePair<string, string>]
/self/users/{userId}/profile/{key}
GET
Retrieve the user profile.
Response Body
String
PUT
Update the user profile.
Request Body
String
Response Body
[KeyValuePair<string, string>]
DELETE
Delete the user profile.
/self/users/{userId}/notifications/
GET
Get user notification settings.
Response Body
UserNotificationSettings
PUT
Update user notification settings.
Request Body
UserNotificationSettings
/self/users/{userId}/permissions/
GET
Get user permissions.
Response Body
...
/Self/Networks/{id:int}/
GET
Get a list of networks associated with a specified id.
Parameters
[int] id:The unique identifier for a network
Response Body
Returns the Network Entity
/Self/Networks/{name}/
GET
Get a list of networks associated with a specified name.
Parameters
[string] name:The name of a network
Response Body
Returns the Network Entity
/Self/Networks/{id:int}/Settings/
GET
Returns the settings associated with a specified network.
Parameters
[int] id:The network identifier
Response Body
Returns the Network Settings Entity
PUT
Update the settings associated with a specified network
Parameters
[int] id:The network identifier
Request Body
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
/Self/Networks/{name}/Settings/
GET
Get the settings associated with a specified network.
Parameters
[string] name:The network name
Response Body
Returns the Network Settings Entity
PUT
Update the settings associated with a specified network
Parameters
[string] id:The network name
Request Body
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
/Self/Users/
GET
Returns all user entities that the customer is associated with over all networks where the person has a user record
Response Body
Returns an array of user entities (see User Entity) if the user is a member of multiple networks, or to a single User Entity if the user is only a member of one network, or nothing if the user is not a member of any network.
/Self/Users/{userid:int}/
GET
Returns information about a specified user on a network
Parameters
[int] id:The unique identifier for a user
Response Body
Returns the User Entity
/Self/Users/{userid:int}/Profile/
GET
Returns the user profile settings
Parameters
[int] id:The unique identifier for a user
Response Body
The return type is object, where property names are profile keys and the profile values are those property values
POST
Creates the user profile property
Parameters
[int] id:The unique identifier for a user
Request Body
[<string, string>] pair:A key value pair. There should be not more than 100 properties per user, and each property value should be not more than 64KB.
Response Body
Returns a 201 status code, the key value pair, and a link to the GET method to retrieve it.
/Self/Users/{userid:int}/Profile/{key}/
GET
Returns the value of a user profile key
Parameters
[int] id:The unique identifier for the user[string] key:The name of the profile property
Response Body
Returns the value of the requested user profile key
PUT
Sets a property value in a user profile
Parameters
[int] id:The unique identifier for the user[string] key:The name of the profile property
Request Body
[string] value:The profile property value to update
Response Body
Returns HTTP status code 201 if the property value is defined for first time, or status code 204 if the property already exists and has been updated.
DELETE
Removes a user profile property
Parameters
[int] id:The unique identifier for the user[string] key:The name of the profile property
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
/Self/Users/{userid:int}/Notifications/
GET
Returns the user notification settings
Parameters
[int] id:The unique identifier for the user
Response Body
Returns the User Notification Settings Entity
PUT
Updates the user notification settings
Parameters
[int] id:The unique identifier for the user
Request Body
The User Notification Settings Entity
Response Body
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
/Self/Users/{userid:int}/Permissions/
GET
Returns permissions for a given user
Parameters
[int] id:A unique identifier for a user
Response Body
Returns an array of Permission Entity entities