How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SEDNA User API API

The User API API from SEDNA — 16 operation(s) for user api.

SEDNA User API API is one of 17 APIs that SEDNA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User API. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 31 operations across 16 paths, and defines 78 schemas. It is described by OpenAPI 3.0.1, at version 2019-01-01.

Requests are made against a single base URL, https://{tenant}.sednanetwork.com/platform.

31 operations 16 paths 78 schemas 7 DELETE15 GET2 PATCH7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2019-01-01
Base URL
https://example.sednanetwork.com/platform
Authentication
HTTP Basic, OAuth 2.0
Contact
Terms of Service
Resource Areas
1

Authentication & Security 2

SEDNA User API API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (Basic). It supports OAuth 2.0 (OAuth) using the clientCredentials flow, exposing 53 scopes. By default, every request must be authenticated.

  • Basic — The basic auth scheme only requires the API-Specific username/password to be set.
  • OAuth — This API prefers OAuth 2 with client credentials flow. You can create your credentials in the Api Credential Management page .

Paths & Operations 31

Across 16 paths, the API surfaces 31 operations — 7 DELETE, 15 GET, 2 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

User API 31
POST
/2019-01-01/user
Create a user Required API Permissions: USERWRITE
create body → default
GET
/2019-01-01/user
Fetch a collection of users Required API Permissions: USERREAD
list_1 10 params → default
DELETE
/2019-01-01/user/{id}
Delete a user Required API Permissions: USERDELETE
delete 1 param → default
GET
/2019-01-01/user/{id}
Fetch a user Required API Permissions: USERREAD
find_2 3 params → default
PATCH
/2019-01-01/user/{id}
Update a user Required API Permissions: USERWRITE
update 1 param body → default
GET
/2019-01-01/user/{id}/default-team
Retrieve a user's primary/default team Required API Permissions: USERREAD, TEAMREAD
getUserDefaultTeam 1 param → default
GET
/2019-01-01/user/{id}/disable-send-teams
Fetch the teams that have sending disabled for the given user. This is an enterprise feature. If you'd like to learn more, please reach out to your account representative. Required API Permissions: U…
getUserDisableSendTeams 1 param → default
GET
/2019-01-01/user/{id}/job-reference
Get a users job reference subscriptions Required API Permissions: USERREAD, JOBREFERENCEREAD
getUserJobReferenceSubscriptions 1 param → default
GET
/2019-01-01/user/{id}/notification-device
Fetch a user's related notification devices Required API Permissions: USERREAD
getUserNotificationDevices 1 param → default
GET
/2019-01-01/user/{id}/relationships/default-team
Retrieve relationship information for a user's default team - the default team is always 'watched' Required API Permissions: USERREAD
getUserDefaultTeamRelationship 1 param → default
PATCH
/2019-01-01/user/{id}/relationships/default-team
Set a user's default or primary team Required API Permissions: USERWRITE
setUserDefaultTeamRelationship 1 param body → default
POST
/2019-01-01/user/{id}/relationships/disable-send-teams
Disable sending for a team for the given user. Sending cannot be disabled for a user's default team. This is an enterprise feature. If you'd like to learn more, please reach out to your account repre…
addUserDisableSendTeamsRelationships 1 param body → default
GET
/2019-01-01/user/{id}/relationships/disable-send-teams
Fetch the team relationships that have sending disabled for the given user. This is an enterprise feature. If you'd like to learn more, please reach out to your account representative. Required API P…
getUserDisableSendTeamsRelationships 1 param → default
DELETE
/2019-01-01/user/{id}/relationships/disable-send-teams
Turn off disable sending for a team for the given user. (ie. Enable sending) This is an enterprise feature. If you'd like to learn more, please reach out to your account representative. Required API…
removeUserDisableSendTeamsRelationships 1 param body → default
GET
/2019-01-01/user/{id}/relationships/job-reference
Get a users job reference relationships Required API Permissions: USERREAD
getUserJobReferenceSubscriptionRelationships 2 params → default
POST
/2019-01-01/user/{id}/relationships/job-reference
Subscribe a user to a job reference Required API Permissions: USERWRITE
subscribeToJobReferences 2 params body → default
DELETE
/2019-01-01/user/{id}/relationships/job-reference
Unsubscribe a user to a job reference Required API Permissions: USERWRITE
unsubscribeToJobReferences 1 param body → default
GET
/2019-01-01/user/{id}/relationships/keyword
Get user's keyword relationships Required API Permissions: USERREAD
getUserKeywordRelationships 1 param → default
POST
/2019-01-01/user/{id}/relationships/keyword
Add keyword relationships to user Required API Permissions: USERWRITE
subscribeUserToKeyword 1 param body → default
DELETE
/2019-01-01/user/{id}/relationships/keyword
Delete keyword relationships to user Required API Permissions: USERWRITE
unsubscribeUserFromKeyword 1 param body → default
GET
/2019-01-01/user/{id}/relationships/notification-device
Fetch a users's notification device relationships Required API Permissions: USERWRITE
getUserNotificationDeviceRelationships 1 param → default
POST
/2019-01-01/user/{id}/relationships/role
Add Roles to User Required API Permissions: USERWRITE
addUserRoleRelationships 1 param body → default
DELETE
/2019-01-01/user/{id}/relationships/role
Remove roles from User Required API Permissions: USERWRITE
removeUserRoleRelationships 1 param body → default
POST
/2019-01-01/user/{id}/relationships/team
Add Teams to User Required API Permissions: USERWRITE
addUserTeamRelationships 1 param body → default
GET
/2019-01-01/user/{id}/relationships/team
Fetch a users's team relationships Required API Permissions: USERREAD
getUserTeamRelationships 1 param → default
DELETE
/2019-01-01/user/{id}/relationships/team
Remove user from teams Required API Permissions: USERWRITE
removeUserTeamRelationships 1 param body → default
POST
/2019-01-01/user/{id}/relationships/watched-teams
Add a watched team to a user - the user must already be able to access the team Required API Permissions: USERWRITE
addUserWatchedTeamsRelationships 1 param body → default
GET
/2019-01-01/user/{id}/relationships/watched-teams
Retrieve relationship data for a user's watched teams - watched teams' mail appears in a user's inbox Required API Permissions: USERREAD
getUserWatchedTeamsRelationships 1 param → default
DELETE
/2019-01-01/user/{id}/relationships/watched-teams
Remove a watched team or teams from a user's watched list - the user must be able to access the teams already Required API Permissions: USERWRITE
removeUserWatchedTeamsRelationships 1 param body → default
GET
/2019-01-01/user/{id}/team
Fetch a user's related teams Required API Permissions: USERREAD, TEAMREAD
getUserTeams 1 param → default
GET
/2019-01-01/user/{id}/watched-teams
Retrieve the teams the user is currently 'watching' - watched teams' mail will appear in the user's inbox Required API Permissions: USERREAD, TEAMREAD
getUserWatchedTeams 1 param → default

Schemas 78

The contract defines 78 schemas that model the data the API accepts and returns. The most detailed are UserAttributes (15 properties), TeamAttributes (15 properties), UserCreateAttributes (12 properties), UserJobReferenceAttributes (11 properties). Each schema is shown below with its type and property counts.

UpdateTeamRelToMany
object
1 property
TeamRelToMany
object
2 properties
Meta
object
2 properties
EventId
object
1 property
UserRelData
object
2 properties
NotificationDeviceRelLinks
object
2 properties
TeamResource
object
6 properties
SoloInboxCreate
object
8 properties 3 required
UserRelationships
object
7 properties
UserReadMeta
object
Document-level metadata for user collection/single reads
KeywordRelToMany
object
2 properties
UpdateRoleRelToMany
object
1 property
TeamAttributeAutoBccEmail
object
2 properties 1 required
UserJobReferenceAttributes
object
11 properties 1 required
UserRelToOne
object
1 property
JobReferenceRelationships
object
4 properties
UserRelToMany
object
2 properties
Tag
object
4 properties
TeamRelationship
object
2 properties
UserSingle
object
3 properties
UserDeactivationPeriodRelToMany
object
1 property
TeamRelationships
object
2 properties
UserCollection
object
4 properties
JobReferenceRelLinks
object
2 properties
JobReferenceRelData
object
3 properties
KeywordRelData
object
2 properties
MessageTag
object
10 properties
UserJobReferenceResource
object
5 properties
CategoryTagRelToMany
object
2 properties
TeamCollection
object
A collection of resources
2 properties
TagName
object
1 property
TeamRelLinks
object
2 properties
Company
object
1 property
TeamAttributes
object
15 properties
UserAttributes
object
15 properties
TeamRelData
object
2 properties
CategoryTagRelData
object
3 properties
UserCreateAttributes
object
12 properties 4 required
TeamRelDataWithFlags
object
2 properties
UpdateTeamRelWithFlags
object
1 property
NotificationDeviceRelationships
object
1 property
RoleRelData
object
2 properties
TeamSingle
object
The resource
1 property
TeamLinks
object
1 property
NotificationDeviceCollection
object
A collection of resources
2 properties
UserUpdateAttributes
object
11 properties
NotificationDeviceRelToMany
object
2 properties
UserUpdateResource
object
1 property
JobReferenceLinks
object
1 property
UserRelLinks
object
2 properties
UserJobReferenceCollection
object
A collection of user job reference resources
2 properties
UserUpdate
object
1 property
NotificationDeviceAttributes
object
4 properties
TagId
object
1 property
NotificationDeviceCollectionLinks
object
3 properties
JobReferenceRelToMany
object
2 properties
MetaObject
object
TeamCollectionLinks
object
3 properties
PrivateLabelRelLinks
object
2 properties
NotificationDeviceLinks
object
1 property
UpdateKeywordRelToMany
object
1 property
ResourceObjectIdentifier
object
3 properties
UserLinks
object
1 property
UserResource
object
5 properties
UserDeactivationPeriodRelData
object
2 properties
MessageTagId
object
1 property
JobReferenceCollectionLinks
object
3 properties
UserCreate
object
1 property
UserCreateResource
object
1 property
TagLabel
object
1 property
CategoryTagRelLinks
object
2 properties
UpdateTeamRelationship
object
1 property
NotificationDeviceRelData
object
2 properties
PrivateLabelRelToMany
object
2 properties
NotificationDeviceResource
object
5 properties
KeywordRelLinks
object
2 properties
UserCollectionLinks
object
3 properties
PrivateLabelRelData
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sedna-user-api-api-openapi.yml Raw ↑

Other APIs SEDNA publishes across the network.

SEDNA Authentication API
SEDNA Category Tag API API
SEDNA Comment API API
SEDNA Company API API
SEDNA Contact API API
SEDNA Document API API
SEDNA Download API API
SEDNA Event API API
SEDNA Job Reference API API
SEDNA Keyword API API
SEDNA Message API API
SEDNA Saved Search API API
Where this information came from

This is an independent, third-party profile of SEDNA User API API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.