Self Endpoints (2020/10)
These endpoints allow users to manage their settings in the current network.
Base URL for these endpoints: https://api.bsn.cloud/2020/10/REST
_________________________________________________________________________
GET /Self/
Returns your https://brightsign.atlassian.net/wiki/spaces/DOC/pages/1206157926 information
Required Scope Token
bsn.api.self.info.retrieve
______________________________________________________________
Response
Success Response with Body
200: Returns the Person Entity
Success Response
304: The resource was not modified since the time specified in the “If-Modified-Since” header
Failure
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
POST /Self/
Registers the person and returns your person credentials (except the password if it was provided in your request).
Required Scope Token
None
______________________________________________________________
Query String Parameter
returnURL string optional
If the value is not specified, the default value is https://bsn.cloud/.
______________________________________________________________
Request Body
The Person Entity. If you specify a password that matches our security policy, the server will apply the password you specify and will not return a password. If you do not specify a password, the server will generate a password and return it to you.
______________________________________________________________
Response
Success Response Body
200: Returns the Person Entity
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: Either the request or request body 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)
415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)
5XX: Any 500 code is an internal server error
PUT /Self/
Updates a person's information. Any customer can edit their own password, first name, and last name regardless of network membership, but cannot edit someone else's name or password.
The login property, whose values are email addresses, is a key and not editable. To give another customer access to that property or handle an email address change, a user with sufficient privileges need to create a new person, add it to the same network, assign them to the same role, and copy the custom user permissions (if any) from an existing user. This can be done in the Users Endpoints (2020/10)#POST API call.
Required Scope
bsn.api.self.info.update
______________________________________________________________
Request Body
The Person Entity
______________________________________________________________
Response
Success
204: The specified person has been updated
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: Either the request or request body 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)
412: Precondition failed (the resource/person changed since the time specified in the “If-Unmodified-Since” header value)
415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)
5XX: Any 500 code is an internal server error
Endpoints:
- 1 GET /Self/
- 2 POST /Self/
- 3 PUT /Self/
- 4 GET /{login}/Password/
- 5 GET /Self/Tokens/{token}/
- 6 DELETE /Self/Tokens/{token}/
- 7 GET /Self/Networks/
- 8 POST /Self/Networks/
- 9 GET /Self/Networks/{id:int}/
- 10 GET /Self/Networks/{name}/
- 11 GET /Self/Networks/{id:int}/Settings/
- 12 PUT /Self/Networks/{id:int}/Settings/
- 13 GET /Self/Networks/{name}/Settings/
- 14 PUT /Self/Networks/{name}/Settings/
- 15 GET /Self/Networks/{id:int}/Subscription/
- 16 PUT /Self/Networks/{id:int}/Subscription/
- 17 GET /Self/Networks/{name}/Subscription/
- 18 PUT /Self/Networks/{name}/Subscription/
- 19 GET /Self/Networks/{id:int}/Subscriptions/
- 20 GET /Self/Networks/{name}/Subscriptions/
- 21 GET /Self/Users/
- 22 GET /Self/Users/{id:int}/
- 23 GET /Self/Users/{id:int}/Role/
- 24 GET /Self/Users/{id:int}/Profile/
- 25 POST /Self/Users/{id:int}/Profile/
- 26 GET /Self/Users/{id:int}/Profile/{key}/
- 27 PUT /Self/Users/{id:int}/Profile/{key}/
- 28 DELETE /Self/Users/{id:int}/Profile/{key}/
- 29 GET /Self/Users/{id:int}/Notifications/
- 30 PUT /Self/Users/{id:int}/Notifications/
- 31 GET /Self/Profile/
- 32 POST /Self/Profile/
- 33 GET /Self/Profile/{key}/
- 34 PUT /Self/Profile/{key}/
- 35 DELETE /Self/Profile/{key}/
- 36 GET /Self/Users/{id:int}/Permissions/
- 37 GET /Self/Users/{id:int}/Role/Permissions/
GET /{login}/Password/
Initiate a password reset for a person
Required Scope
None
______________________________________________________________
Segment
login string required
The person's login information in the form of an email address
returnURL string optional
A callback URL that the authentication server will return to the user in the case of a successful password reset
______________________________________________________________
Response
Success Response Body
202: On success, this method triggers an email to your login which contains a reference to a password reset page and a return URL as a callback
Failure
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
404: The server cannot find the requested resource (the path does not exist)
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
GET /Self/Tokens/{token}/
Gets the status of the specified OAuth2 person access or refresh token
Required Scope Token
bsn.api.self.token.validate
______________________________________________________________
Segment
token string
A person access or refresh token
______________________________________________________________
Response
Success Response Body
200: Returns the Token Info Entity
Failure
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
404: The specified person or access refresh token is expired, revoked, or invalid.
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
DELETE /Self/Tokens/{token}/
Revokes a person access or refresh token
Required Scope Token
bsn.api.self.token.revoke
______________________________________________________________
Segment
token string
A person access or refresh token
______________________________________________________________
Response
Success
204: The person access or refresh token has been deleted
Failure
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
404: The specified person or access refresh token is expired, revoked, or invalid.
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
GET /Self/Networks/
Returns the networks associated with a person
Required Scope Token
bsn.api.self.networks.retrieve
______________________________________________________________
Response
Success Response Body
200: Returns an array of Network Entity instances in which the current person is a member.
Failure
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
POST /Self/Networks/
Creates a network for the person
Required Scope Token
bsn.api.self.networks.create
______________________________________________________________
Request Body
The Network Entity
______________________________________________________________
Response
Success Response Body
201: Returns the new resource created and referenced by the Uri (given by the Location header field) in the response. The response includes the network entity (see Network Entity).
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: Either the request or request body 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)
415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)
5XX: Any 500 code is an internal server error
GET /Self/Networks/{id:int}/
Returns a network associated with a specified id.
Required Scope Token
bsn.api.self.networks.retrieve
______________________________________________________________
Segment
id int
The unique identifier for a network
______________________________________________________________
Response
Success Response with Body
200: Returns the Network Entity
Success Response
304: The resource was not modified since the time specified in the “If-Modified-Since” header
Failure
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
404: The server cannot find the requested resource (the path does not exist)
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
GET /Self/Networks/{name}/
Returns a network associated with a specified name.
Required Scope Token
bsn.api.self.networks.retrieve
______________________________________________________________
Segment
name string
The name of a network
______________________________________________________________
Response
Success Response Body
200: Returns the Network Entity
Success Response
304: The resource was not modified since the time specified in the “If-Modified-Since” header
Failure
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
404: The server cannot find the requested resource (the path does not exist)
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
GET /Self/Networks/{id:int}/Settings/
Returns the settings associated with a specified network.
Required Scope Token
bsn.api.self.networks.retrieve
______________________________________________________________
Segment
id int
The unique identifier for a network
______________________________________________________________
Response
Success Response with Body
200: Returns the Network Settings Entity
Success Response
304: The resource was not modified since the time specified in the “If-Modified-Since” header
Failure
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
404: The server cannot find the requested resource (the path does not exist)
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
PUT /Self/Networks/{id:int}/Settings/
Update the settings associated with a specified network
Required Scope Token
bsn.api.self.networks.update
______________________________________________________________
Segment
id int
The unique identifier for a network
______________________________________________________________
Request Body
______________________________________________________________
Response
Success
204: The specified settings have been updated on the network
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: Either the request or request body 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
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)
5XX: Any 500 code is an internal server error
GET /Self/Networks/{name}/Settings/
Get the settings associated with a specified network
Required Scope Token
bsn.api.self.networks.retrieve
______________________________________________________________
Segment
name string
The name of a network
______________________________________________________________
Response
Success Response Body
200: Returns the Network Settings Entity
Failure
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
404: The server cannot find the requested resource (the path does not exist)
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
PUT /Self/Networks/{name}/Settings/
Update the settings associated with a specified network
Required Scope Token
bsn.api.self.networks.update
______________________________________________________________
Segment
name string
The name of a network
______________________________________________________________
Request Body
______________________________________________________________
Response
Success
204: The network settings have been updated
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: Either the request or request body 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
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)
5XX: Any 500 code is an internal server error
GET /Self/Networks/{id:int}/Subscription/
Returns the current subscription information associated with a specified network
Required Scope Token
bsn.api.self.networks.retrieve
______________________________________________________________
Segment
id int
The unique identifier for a network
______________________________________________________________
Response
Success Response with Body
200: Returns the Network Subscription Entity
Success Response
304: The resource was not modified since the time specified in the “If-Modified-Since” header
Failure
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
404: The server cannot find the requested resource (the path does not exist)
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
PUT /Self/Networks/{id:int}/Subscription/
Updates the current subscription information associated with a specified network. A regular user can only use this to enable a trial period of the Content Cloud (if it was not previously enabled).
Required Scope Token
bsn.api.self.networks.update
______________________________________________________________
Segment
id int
The unique identifier for a network
______________________________________________________________
Request Body
The Network Subscription Entity
______________________________________________________________
Response
Success
204: The subscription information was updated
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: Either the request or request body 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
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)
415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)
5XX: Any 500 code is an internal server error
GET /Self/Networks/{name}/Subscription/
Returns the current subscription information associated with a specified network
Required Scope
bsn.api.self.networks.retrieve
______________________________________________________________
Segment
name string
The name of a network
______________________________________________________________
Response
Success Response Body
200: Returns the Network Subscription Entity
Failure
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
404: The server cannot find the requested resource (the path does not exist)
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
PUT /Self/Networks/{name}/Subscription/
Updates the current subscription information associated with a specified network. A regular user can only use this to enable a trial period of the Content Cloud (if it was not previously enabled).
Required Scope Token
bsn.api.self.networks.update
______________________________________________________________
Segment
name string
The name of a network
______________________________________________________________
Request Body
The Network Subscription Entity
______________________________________________________________
Response
Success
204: Updated the subscription information associated with the network
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: Either the request or request body 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
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)
5XX: Any 500 code is an internal server error
GET /Self/Networks/{id:int}/Subscriptions/
Returns the current subscription, and all previously expired subscriptions, associated with a specified network
Required Scope Token
bsn.api.self.networks.retrieve
______________________________________________________________
Segment
id int
The unique identifier for a network
______________________________________________________________
Response
Success Response Body
200: Returns an array of Network Subscription entities
Failure
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
404: The server cannot find the requested resource (the path does not exist)
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
GET /Self/Networks/{name}/Subscriptions/
Returns the current subscription, and all previously expired subscriptions, associated with a specified network
Required Scope Token
bsn.api.self.networks.retrieve
______________________________________________________________
Segment
name string
The name of a network
______________________________________________________________
Response
Success Response Body
200: Returns an array of Network Subscription entities
Failure
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
404: The server cannot find the requested resource (the path does not exist)
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
GET /Self/Users/
Returns all user entities that the customer is associated with over all networks where the person has a user record
Required Scope Token
bsn.api.self.users.retrieve
______________________________________________________________
Response
Success Response Body
200: 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.
Failure
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
GET /Self/Users/{id:int}/
Returns information about your membership in a network
Required Scope Token
bsn.api.self.users.retrieve
______________________________________________________________
Segment
id int
The unique identifier for a user
______________________________________________________________
Response
Success Response with Body
200: Returns the User Entity
Success Response
304: The resource was not modified since the time specified in the “If-Modified-Since” header
Failure
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
404: The server cannot find the requested resource (the path does not exist)
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
GET /Self/Users/{id:int}/Role/
Returns information about the role you have in a network
Required Scope Token
bsn.api.self.roles.retrieve
______________________________________________________________
Segment
id int
The unique identifier for a user
______________________________________________________________
Response
Success Response with Body
200: This returns the User Entity.
Success Response
204: No content (the user is not assigned to a role)
Failure
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
404: The server cannot find the requested resource (the path does not exist)
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
GET /Self/Users/{id:int}/Profile/
Returns the user profile settings
Required Scope Token
bsn.api.self.users.profile.retrieve
______________________________________________________________
Segment
id int
The unique identifier for a user
______________________________________________________________
Response
Success Response Body
200: The return type is object, where property names are profile keys and the profile values are those property values
Failure
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
404: The server cannot find the requested resource (the path does not exist)
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
POST /Self/Users/{id:int}/Profile/
Creates a new user profile property (it does not replace an existing user profile property)
Required Scope Token
bsn.api.self.users.profile.update
______________________________________________________________
Segment
id int
The unique identifier for a user
______________________________________________________________
Request Body
pair <string, string>
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
Success Response Body
201: Returns the key value pair and a link to the GET method to retrieve it.
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: Either the request or request body 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
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
409: The profile property with the specified key already exists or is reserved
413: The specified profile property value size exceeds the 64KB limit
415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)
5XX: Any 500 code is an internal server error
GET /Self/Users/{id:int}/Profile/{key}/
Returns the value of a user profile key
Required Scope Token
bsn.api.self.users.profile.retrieve
______________________________________________________________
Segment
id int
The unique identifier for a user
key string
The name of the profile property
______________________________________________________________
Response
Success Response with Body
200: Returns the value of the requested user profile key
Success Response
304: The resource was not modified since the time specified in the “If-Modified-Since” header
Failure
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
404: The server cannot find the requested resource (the path does not exist)
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
PUT /Self/Users/{id:int}/Profile/{key}/
Creates or updates the value of a user property value
Required Scope Token
bsn.api.self.users.profile.update
______________________________________________________________
Segments
id int
The unique identifier for a user
key string
The name of the profile property
______________________________________________________________
Request Body
string
The profile property value to update
______________________________________________________________
Response
Success
201: Returns this status code if the property value is defined for first time
204: Returns this status code if the property already exists and has been updated
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: Either the request is malformed and therefore invalid, or the specified user profile property key is reserved or longer than 62 characters
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)
413: The length of the specified user profile property exceeds the 64KB limit
415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)
5XX: Any 500 code is an internal server error
DELETE /Self/Users/{id:int}/Profile/{key}/
Removes a specified property from a user profile
Required Scope Token
bsn.api.self.users.profile.update
______________________________________________________________
Segments
id int
The unique identifier for a user
key string
The name of the profile property
______________________________________________________________
Response
Success
204: The specified property has been removed from the user profile
Failure
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
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)
5XX: Any 500 code is an internal server error
GET /Self/Users/{id:int}/Notifications/
Returns the user notification settings
Required Scope Token
bsn.api.self.users.notifications.retrieve
______________________________________________________________
Segment
id int
A unique identifier for a user
______________________________________________________________
Response
Success Response Body
200: Returns information about whether each setting in User Notification Settings Entity is enabled or disabled
Failure
300: The user entity is not specified correctly (there is more than one possible response)
400: Either the request or the user entity is invalid or not specified
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource (the path does not exist)
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
PUT /Self/Users/{id:int}/Notifications/
Updates the user notification settings
Required Scope Token
bsn.api.self.users.notifications.update
______________________________________________________________
Segment
id int
A unique identifier for a user
______________________________________________________________
Request Body
The User Notification Settings Entity
______________________________________________________________
Response
Success
204: The specified user notification settings have been updated on the network
Failure
300: An acceptable user notification settings entity is not specified
400: Either the request or the user entity is invalid or not specified
401: The access token is invalid or not specified
403: The supplied access token, though valid, doesn't provide access to this method
404: The server cannot find the requested resource
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
415: The specified representation of the user notification settings entity is invalid or not supported
5XX: Any 500 code is an internal server error
GET /Self/Profile/
Returns a complete person profile
Required Scope Token
bsn.api.self.profile.retrieve
______________________________________________________________
Response
Success Response with Body
200: The return type is object, where property names are profile keys and the profile values are those property values
Failure
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
5XX: Any 500 code is an internal server error
POST /Self/Profile/
Creates a new profile property for the person
Required Scope Token
bsn.api.self.profile.update
______________________________________________________________
Request Body
pair <string, string>
A key value pair of the person profile property
______________________________________________________________
Response
Success Response Body
201: Returns the new resource created and referenced by the Uri (given by the Location header field) in the response. Returns an object where property names correspond to profile keys and property values correspond to profile names.
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: Either the request is malformed and therefore invalid, or the specified profile property key is reserved or longer than 62 characters
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)
409: The person profile property with the specified key already exists
413: The length of the specified person property profile value exceeds the 64KB limit
415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)
5XX: Any 500 code is an internal server error
GET /Self/Profile/{key}/
Returns a profile property value for a person
Required Scope Token
bsn.api.self.profile.retrieve
______________________________________________________________
Segment
key string
The name of the profile property
______________________________________________________________
Response
Success Response Body
200: Returns a profile property value
Success Response
304: The resource was not modified since the time specified in the “If-Modified-Since” header
Failure
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
404: The server cannot find the requested resource (the path does not exist)
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
PUT /Self/Profile/{key}/
Creates or updates a person profile property value
Required Scope Token
bsn.api.self.profile.update
______________________________________________________________
Segment
key string
The name of the profile property
______________________________________________________________
Request Body
string
The profile property value to update
______________________________________________________________
Response
Success
201: Returns this status code if the person property value is defined for first time
204: Returns this status code if the person property value already exists and has been updated
Failure
300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)
400: Either the request or request body 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
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)
413: The length of the specified user profile property exceeds the 64KB limit
415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)
5XX: Any 500 code is an internal server error
DELETE /Self/Profile/{key}/
Removes a profile property for a person
Required Scope Token
bsn.api.self.profile.update
______________________________________________________________
Segment
key string
The name of the profile property
______________________________________________________________
Response
Success
204: The profile property has been removed
Failure
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
404: The server cannot find the requested resource (the path does not exist)
406: The server cannot return the data representation that you requested (as specified in the "Accept" header)
412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)
5XX: Any 500 code is an internal server error
GET /Self/Users/{id:int}/Permissions/
Returns the permissions granted to a given user
Required Scope Token
bsn.api.self.users.retrieve
______________________________________________________________
Segment
id int
A unique identifier for a user
______________________________________________________________
Response
Success Response Body
200: Returns the paged list of Permission entities granted to a specific user
Failure
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
404: The server cannot find the requested resource (the path does not exist)
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
GET /Self/Users/{id:int}/Role/Permissions/
Returns the permissions granted to a a given user
Required Scope Token
bsn.api.self.roles.retrieve
______________________________________________________________
Segment
id int
A unique identifier for a user
______________________________________________________________
Response
Success Response Body
200: Returns the array of Permission entities granted to a specific role
Failure
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
404: The server cannot find the requested resource (the path does not exist)
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