...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
| Panel | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
ON THIS PAGE
|
These endpoints allow users to manage their settings in the current network.
/self/
GET
Gets the information associated with the user in the current network.
Parameters
Person: An array of information about a person in the network
Response Body
[int] id:The network id[string] login:The network login email[string] password:The network password[string] firstName:The first name of the network owner[string] lastName:The last name of the network owner[string] creationDate:The creation date of the network[string] lastModifiedDate:The last date on which the network was modified[string] activationDate:The activation date of the network
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
Person
Response Body
Person
PUT
Updates the users information in the current network.
Request Body
Person
/self/profile
GET
Gets the users profile settings.
Response Body
Dictionary<string, string>
POST
Updates the users profile settings.
Request Body
KeyValuePair<string, string>
Response 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
Network
Response Body
Network
/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
...