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

These endpoints allow users to manage their settings in the current BSN.com network.

/self/

GET

Gets the information associated with the user in the current network.

...

  • Person : An array of information about a person in the network

Response Body

  • [int]  idId: The network iduser id
  • [string] Login: The user login name
  • [string] login Email: The network  The user login email
  • [string] password Password: The network  The user password
  • [string]  firstNameFirstName: The first name of the network owneruser
  • [string]  lastNameLastName: The last name of the network owneruser
  • [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 networkCreationDate: 

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.

...

  • [returnURL] This parameter is optional. If it is not specified, the parameters value from BSN configuration file will be used.

Request Body

  • [int]  idId:
  • [string]  loginLogin: The user login name
  • [string]  emailEmail: The user login email
  • [string]  passwordPassword: The user password
  • [string]  firstNameFirstName: The first name of the user
  • [string]  lastNameLastName: The last name of the user
  • [string]  creationDateCreationDate: 


Response Body

  • Person

PUT

Updates the users information in the current network.

Request Body

  • Person

Response Body

On success this method returns a status code 204, on failure it returns a status code of 500.

/self/profile

GET

Gets the users profile settings.

...

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 applicable
  • settings
    • [string] userAccessTokenLifetime
    • [string] userRefreshTokenLifetime
    • [string] deviceAccessTokenLifetime
    • [string] deviceRefreshTokenLifetime
    • [string] deviceRegistrationTokenLifetime
    • [bool] automaticSubscriptionsManagementEnabled
    • [bool] automaticTaggedPlaylistApprovementEnabled

...

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/

...