REST API for Users and Groups

URL Structure

Access the Users and Groups REST resources with the following URL structure:

https://oracleContentInstance-identityName.network.dataCenter.oraclecloud.com/osn/social/api/v1/resource-path

Where:

oracleContentInstance - Name you chose for your Oracle Content Management Cloud instance when it was provisioned.
identityName - Identity name you chose when you signed up with Oracle Public Cloud.
network - Name of your network.
dataCenter - Data center that Oracle Content Management Cloud is set up to use.
resource-path - Relative path that defines the resource.

Supported Methods

You can perform basic CRUD operations (create, read, update, and delete) on a resource by using standard HTTP method requests, as summarized in the following table.

HTTP Method	Description
`GET`	Get information about a resource or resources, including users, groups, one-on-one conversations, followers, pictures, or gadgets.
`POST`	Create, add to, like, or star a resource, or set a field, a property, or properties on a resource.
`PUT`	Update or mark a resource or mark a followup or followups for a resource.
`DELETE`	Remove a resource, un-like or un-star a resource, close a followup or followups for a resource, disconnect a connection, or remove a member, property or properties, or field from a resource.

Media Types

The REST API for Users and Groups supports the following media type:

application/json

Supported Headers

The REST API for Users and Groups supports the following headers, which can be passed in the header section of the HTTP request or response.

Header	Description	Example
`Accept-Encoding`	List of acceptable encodings to support compression.	`Accept-Encoding: gzip`
`Content-Encoding`	List of acceptable encodings to support compression.	`Content-Encoding: deflate`
`Content-Type`	Media type of the body of the request. Required for POST and PUT requests.	`Content-Type: application/json`

Compression

Use compression on the REST API for Users and Groups resource request and response for improved performance. To use compression, include one of the following HTTP headers in the request: Accept-Encoding or Content-Encoding.