Returns the networks associated with a person
Returns a complete list of Network Entity instances associated with a person.
Creates a network for the person.
The Network Entity
Returns a 201 status code and 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).
Get a list of networks associated with a specified id.
[int] id:
The unique identifier for a networkReturns the Network Entity
Get a list of networks associated with a specified name.
[string] name:
The name of a networkReturns the Network Entity
Returns the settings associated with a specified network.
[int] id:
The network identifierReturns the Network Settings Entity
Update the settings associated with a specified network
[int] id:
The network identifierOn success this method returns a status code 2XX, on failure it returns a status code of 5XX.
Get the settings associated with a specified network.
[string] name:
The network nameReturns the Network Settings Entity
Update the settings associated with a specified network
[string] id:
The network nameOn success this method returns a status code 2XX, on failure it returns a status code of 5XX.
Returns the current subscription Information associated with a specified network.
[int] id:
The network identifierReturns the Network Subscription Entity
Update the current subscription information associated with a specified network
[int] id:
The network identifierThe Network Subscription Entity
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
Returns the current subscription information associated with a specified network.
[string] name:
The network nameReturns the Network Subscription Entity
Updates the current subscription information associated with a specified network
[string] name:
The network nameThe Network Subscription Entity
On success this method returns a status code 2XX, on failure it returns a status code of 5XX.
Returns all of the network subscriptions associated with a specified network.
[int] id:
The network identifierReturns all Network Subscription entities on a network
Returns all of the network subscriptions associated with a specified network.
[string] name:
The network nameReturns all Network Subscription entities on a network
Returns all user entities that the customer is associated with over all networks where the person has a user record
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.
Returns information about a specified user on a network
[int] id:
The unique identifier for a userReturns the User Entity
Returns information about a specified user role on a network
[int] id:
The unique identifier for a userIf the user is not assigned to a role, then the expected response status is 204 (No content). Otherwise this returns the User Entity.
Returns the user profile settings
[int] id:
The unique identifier for a userThe return type is object, where property names are profile keys and the profile values are those property values
Creates the user profile property
[int] id:
The unique identifier for a user[<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. Returns a 201 status code, the key value pair, and a link to the GET method to retrieve it.
Returns the value of a user profile key
[int] id:
The unique identifier for the user[string] key:
The name of the profile propertyReturns the value of the requested user profile key
Sets a property value in a user profile
[int] id:
The unique identifier for the user[string] key:
The name of the profile property[string] value:
The profile property value to updateReturns 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.
Removes a user profile property
[int] id:
The unique identifier for the user[string] key:
The name of the profile propertyOn success this method returns a status code 2XX, on failure it returns a status code of 5XX.
Returns a complete person profile
The return type is object, where property names are profile keys and the profile values are those property values
Creates a profile property for the person
[<string, string>] pair:
A key value pair of the person and profile propertyReturns a 201 status code and 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.
Returns a profile property value for a person
[string] key:
The name of the profile propertyReturns a profile property value
Sets a profile property value for a person
[string] key:
The name of the profile property[string] value:
The profile property value to updateOn success this method returns a status code 2XX, on failure it returns a status code of 5XX.
Removes a profile property for a person
[string] key:
The name of the profile propertyOn success this method returns a status code 2XX, on failure it returns a status code of 5XX.
Returns permissions for a given user
[int] id:
A unique identifier for a userReturns an array of Permission Entity entities
Returns permissions for a given user role.
[int] id:
A unique identifier for a userReturns the Permission Entity for a given user role