Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel
borderColor#3D3D3D
bgColor#F4F4F4
titleColor#3D3D3D
borderWidth0
titleBGColor#3D3D3D
borderStylesolid

ON THIS PAGE

Table of Contents
maxLevel3
indent20px

...

  • [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.

...

Gets the users profile settings.

Response Body

  • Dictionary<string, string>

...

  • KeyValuePair<string, string>

Response Body

  • KeyValuePair<string, string>

...

Gets the users profile settings.

Response Body

  • String

PUT

Updates the users profile settings.

Request Body

  • String

Response Body

  • [KeyValuePair<string, string>]

...

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 applicable
  • settings
    • [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

...

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/

...

Retrieve the network settings.

Response Body

  • Network Settings

/self/networks/{networkName}/settings/

PUT

Request Body

  • Network Settings

/self/networks/{networkId}/subscription/

...

Gets the network subscription information for the user.

Response Body

  • Network Subscription

/self/users/

...

Gets the names of the user(s) on the current network

Response Body

  • User[]

/self/users/{userId}/

...

Gets the id(s) of the users on the current network

Response Body

  • User

/self/users/{userId}/role

...

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)

...

Gets the role permissions of the users on the current network

Response Body

  • Permission[]
  • Dictionary<string, string>

...

  • [KeyValuePair<string, string>]

Response Body

  • [KeyValuePair<string, string>]

...

Retrieve the user profile.

Response Body

  • String

PUT

Update the user profile.

Request Body

  • String

Response Body

  • [KeyValuePair<string, string>]

...

Get user notification settings.

Response Body

  • UserNotificationSettings

PUT

...

/self/users/{userId}/permissions/

GET

Get user permissions.

Response Body

  • Permission[]