SEDNA User API API
The User API API from SEDNA — 16 operation(s) for user api.
The User API API from SEDNA — 16 operation(s) for user api.
openapi: 3.0.1
info:
contact:
name: Support
url: https://support.sedna.com
termsOfService: https://www.sedna.com/terms-of-service
title: Sedna Authentication User API API
version: '2019-01-01'
servers:
- description: Platform endpoint
url: https://{tenant}.sednanetwork.com/platform
variables:
tenant:
default: example
description: Your tenant's unique identifier
security:
- Basic: []
- OAuth: []
tags:
- name: User API
paths:
/2019-01-01/user:
post:
description: 'Create a user
Required API Permissions: USER_WRITE'
operationId: create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserCreate'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UserCreate'
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/UserSingle'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UserSingle'
description: default response
tags:
- User API
get:
description: 'Fetch a collection of users
Required API Permissions: USER_READ'
operationId: list_1
parameters:
- in: query
name: page[limit]
schema:
type: integer
format: int64
default: 100
- in: query
name: page[offset]
schema:
type: integer
format: int64
default: 0
- in: query
name: include
schema:
type: string
- in: query
name: fields[user]
schema:
type: string
- in: query
name: filter[user.ssoEmail]
schema:
type: string
- example: 3,5,7
in: query
name: filter[user.id]
schema:
type: string
- deprecated: true
in: query
name: ssoEmail
schema:
type: string
- in: query
name: filter[user.firstName]
schema:
type: string
- in: query
name: filter[user.lastName]
schema:
type: string
- in: query
name: sortBy
schema:
type: string
enum:
- username.asc
- username.desc
- firstName.asc
- firstName.desc
- lastName.asc
- lastName.desc
- initials.asc
- initials.desc
- ssoEmail.asc
- ssoEmail.desc
- lastLogin.asc
- lastLogin.desc
- createdAt.asc
- createdAt.desc
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/UserCollection'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UserCollection'
description: default response
tags:
- User API
/2019-01-01/user/{id}:
delete:
description: 'Delete a user
Required API Permissions: USER_DELETE'
operationId: delete
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
responses:
default:
content:
application/json: {}
application/vnd.api+json: {}
description: default response
tags:
- User API
get:
description: 'Fetch a user
Required API Permissions: USER_READ'
operationId: find_2
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
- in: query
name: include
schema:
type: string
- in: query
name: fields[user]
schema:
type: string
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/UserSingle'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UserSingle'
description: default response
tags:
- User API
patch:
description: 'Update a user
Required API Permissions: USER_WRITE'
operationId: update
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserUpdate'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UserUpdate'
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/UserSingle'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UserSingle'
description: default response
tags:
- User API
/2019-01-01/user/{id}/default-team:
get:
description: 'Retrieve a user''s primary/default team
Required API Permissions: USER_READ, TEAM_READ'
operationId: getUserDefaultTeam
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/TeamSingle'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/TeamSingle'
description: default response
tags:
- User API
/2019-01-01/user/{id}/disable-send-teams:
get:
description: "\nFetch the teams that have sending disabled for the given user.\n\n**This is an enterprise feature.** If you'd like to learn more, please reach out to your account representative.\n \n\nRequired API Permissions: USER_READ, TEAM_READ"
operationId: getUserDisableSendTeams
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/TeamCollection'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/TeamCollection'
description: default response
tags:
- User API
/2019-01-01/user/{id}/job-reference:
get:
description: 'Get a users job reference subscriptions
Required API Permissions: USER_READ, JOBREFERENCE_READ'
operationId: getUserJobReferenceSubscriptions
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/UserJobReferenceCollection'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UserJobReferenceCollection'
description: default response
tags:
- User API
/2019-01-01/user/{id}/notification-device:
get:
description: 'Fetch a user''s related notification devices
Required API Permissions: USER_READ'
operationId: getUserNotificationDevices
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationDeviceCollection'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/NotificationDeviceCollection'
description: default response
tags:
- User API
/2019-01-01/user/{id}/relationships/default-team:
get:
description: 'Retrieve relationship information for a user''s default team - the default team is always ''watched''
Required API Permissions: USER_READ'
operationId: getUserDefaultTeamRelationship
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/TeamRelationship'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/TeamRelationship'
description: default response
tags:
- User API
patch:
description: 'Set a user''s default or primary team
Required API Permissions: USER_WRITE'
operationId: setUserDefaultTeamRelationship
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTeamRelationship'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UpdateTeamRelationship'
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/TeamRelationship'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/TeamRelationship'
description: default response
tags:
- User API
/2019-01-01/user/{id}/relationships/disable-send-teams:
post:
description: '
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 representative.
Required API Permissions: USER_WRITE'
operationId: addUserDisableSendTeamsRelationships
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTeamRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UpdateTeamRelToMany'
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/TeamRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/TeamRelToMany'
description: default response
tags:
- User API
get:
description: "\nFetch the team relationships that have sending disabled for the given user.\n\n**This is an enterprise feature.** If you'd like to learn more, please reach out to your account representative.\n \n\nRequired API Permissions: USER_READ"
operationId: getUserDisableSendTeamsRelationships
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/TeamRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/TeamRelToMany'
description: default response
tags:
- User API
delete:
description: '
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 Permissions: USER_WRITE'
operationId: removeUserDisableSendTeamsRelationships
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTeamRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UpdateTeamRelToMany'
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/TeamRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/TeamRelToMany'
description: default response
tags:
- User API
/2019-01-01/user/{id}/relationships/job-reference:
get:
description: 'Get a users job reference relationships
Required API Permissions: USER_READ'
operationId: getUserJobReferenceSubscriptionRelationships
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
- in: query
name: filter[createdBy]
schema:
type: string
enum:
- api
- ui
- '{userId}'
example: api
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/JobReferenceRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/JobReferenceRelToMany'
description: default response
tags:
- User API
post:
description: 'Subscribe a user to a job reference
Required API Permissions: USER_WRITE'
operationId: subscribeToJobReferences
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
- description: allow user to manage this subscription
in: query
name: managedByUser
schema:
type: boolean
default: false
enum:
- true
- false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/JobReferenceRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/JobReferenceRelToMany'
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/JobReferenceRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/JobReferenceRelToMany'
description: default response
tags:
- User API
delete:
description: 'Unsubscribe a user to a job reference
Required API Permissions: USER_WRITE'
operationId: unsubscribeToJobReferences
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/JobReferenceRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/JobReferenceRelToMany'
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/JobReferenceRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/JobReferenceRelToMany'
description: default response
tags:
- User API
/2019-01-01/user/{id}/relationships/keyword:
get:
description: 'Get user''s keyword relationships
Required API Permissions: USER_READ'
operationId: getUserKeywordRelationships
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/KeywordRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/KeywordRelToMany'
description: default response
tags:
- User API
post:
description: 'Add keyword relationships to user
Required API Permissions: USER_WRITE'
operationId: subscribeUserToKeyword
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateKeywordRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UpdateKeywordRelToMany'
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/KeywordRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/KeywordRelToMany'
description: default response
tags:
- User API
delete:
description: 'Delete keyword relationships to user
Required API Permissions: USER_WRITE'
operationId: unsubscribeUserFromKeyword
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateKeywordRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UpdateKeywordRelToMany'
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/KeywordRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/KeywordRelToMany'
description: default response
tags:
- User API
/2019-01-01/user/{id}/relationships/notification-device:
get:
description: 'Fetch a users''s notification device relationships
Required API Permissions: USER_WRITE'
operationId: getUserNotificationDeviceRelationships
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationDeviceRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/NotificationDeviceRelToMany'
description: default response
tags:
- User API
/2019-01-01/user/{id}/relationships/role:
post:
description: 'Add Roles to User
Required API Permissions: USER_WRITE'
operationId: addUserRoleRelationships
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateRoleRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UpdateRoleRelToMany'
responses:
default:
content:
application/json: {}
application/vnd.api+json: {}
description: default response
tags:
- User API
delete:
description: 'Remove roles from User
Required API Permissions: USER_WRITE'
operationId: removeUserRoleRelationships
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateRoleRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UpdateRoleRelToMany'
responses:
default:
content:
application/json: {}
application/vnd.api+json: {}
description: default response
tags:
- User API
/2019-01-01/user/{id}/relationships/team:
post:
description: 'Add Teams to User
Required API Permissions: USER_WRITE'
operationId: addUserTeamRelationships
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTeamRelWithFlags'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UpdateTeamRelWithFlags'
responses:
default:
content:
application/json: {}
application/vnd.api+json: {}
description: default response
tags:
- User API
get:
description: 'Fetch a users''s team relationships
Required API Permissions: USER_READ'
operationId: getUserTeamRelationships
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/TeamRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/TeamRelToMany'
description: default response
tags:
- User API
delete:
description: 'Remove user from teams
Required API Permissions: USER_WRITE'
operationId: removeUserTeamRelationships
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTeamRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UpdateTeamRelToMany'
responses:
default:
content:
application/json: {}
application/vnd.api+json: {}
description: default response
tags:
- User API
/2019-01-01/user/{id}/relationships/watched-teams:
post:
description: 'Add a watched team to a user - the user must already be able to access the team
Required API Permissions: USER_WRITE'
operationId: addUserWatchedTeamsRelationships
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTeamRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UpdateTeamRelToMany'
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/TeamRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/TeamRelToMany'
description: default response
tags:
- User API
get:
description: 'Retrieve relationship data for a user''s watched teams - watched teams'' mail appears in a user''s inbox
Required API Permissions: USER_READ'
operationId: getUserWatchedTeamsRelationships
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/TeamRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/TeamRelToMany'
description: default response
tags:
- User API
delete:
description: '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: USER_WRITE'
operationId: removeUserWatchedTeamsRelationships
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTeamRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UpdateTeamRelToMany'
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/TeamRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/TeamRelToMany'
description: default response
tags:
- User API
/2019-01-01/user/{id}/team:
get:
description: 'Fetch a user''s related teams
Required API Permissions: USER_READ, TEAM_READ'
operationId: getUserTeams
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/TeamCollection'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/TeamCollection'
description: default response
tags:
- User API
/2019-01-01/user/{id}/watched-teams:
get:
description: 'Retrieve the teams the user is currently ''watching'' - watched teams'' mail will appear in the user''s inbox
Required API Permissions: USER_READ, TEAM_READ'
operationId: getUserWatchedTeams
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/TeamCollection'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/TeamCollection'
description: default response
tags:
- User API
components:
schemas:
UpdateTeamRelToMany:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TeamRelData'
TeamRelToMany:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TeamRelData'
links:
$ref: '#/components/schemas/TeamRelLinks'
Meta:
type: object
properties:
disableSend:
type: boolean
watched:
type: boolean
EventId:
type: object
properties:
id:
type: integer
format: int64
UserRelData:
type: object
properties:
id:
type: string
type:
type: string
NotificationDeviceRelLinks:
type: object
properties:
related:
type: string
self:
type: string
TeamResource:
type: object
properties:
attributes:
$ref: '#/components/schemas/TeamAttributes'
id:
type: string
links:
$ref: '#/components/schemas/TeamLinks'
relationships:
$ref: '#/components/schemas/TeamRelationships'
type:
type: string
description: the type of the resource
enum:
- team
uuid:
type: string
SoloInboxCreate:
type: object
properties:
additionalEmailAddresses:
type: array
items:
type: string
emailAddress:
type: string
emailSignature:
type: string
foreignKey:
type: string
name:
type: string
public:
type: boolean
purpose:
type: string
sendingName:
type: string
required:
- additionalEmailAddresses
- emailAddress
- name
UserRelationships:
type: object
properties:
deactivationPeriod:
$ref: '#/components/schemas/UserDeactivationPeriodRelToMany'
defaultTeam:
$ref: '#/components/schemas/TeamRelationship'
disableSendTeams:
$ref: '#/components/schemas/TeamRelToMany'
notificationDevice:
$ref: '#/components/schemas/NotificationDeviceRelToMany'
privateLabel:
$ref: '#/components/schemas/PrivateLabelRelToMany'
team:
$ref: '#/components/schemas/TeamRelToMany'
watchedTeams:
$ref: '#/components/schemas/TeamRelToMany'
UserReadMeta:
type: object
description: Document-level metadata for user collection/single reads
KeywordRelToMany:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/KeywordRelData'
links:
$ref: '#/components/schemas/KeywordRelLinks'
UpdateRoleRelToMany:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/RoleRelData'
maxItems: 2147483647
minItems: 1
TeamAttributeAutoBccEmail:
type: object
properties:
email:
type: string
name:
type: string
required:
- email
UserJobReferenceAttributes:
type: object
properties:
archived:
type: boolean
attributes:
type: string
createdAt:
type: string
date:
type: string
foreignKey:
type: string
modifiedAt:
type: string
name:
type: string
source:
type: string
subscribedAt:
type: string
description: when the user subscribed to this job reference
example: '2025-04-23T14:52:54Z'
tagId:
type: string
type:
type: string
required:
- name
UserRelToOne:
type: object
properties:
data:
$ref: '#/components/schemas/UserRelData'
JobReferenceRelationships:
type: object
properties:
company:
$ref: '#/components/schemas/Company'
tag:
$ref: '#/components/schemas/Tag'
team:
$ref: '#/components/schemas/TeamRelToMany'
user:
$ref: '#/components/schemas/UserRelToMany'
UserRelToMany:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/UserRelData'
links:
$ref: '#/components/schemas/UserRelLinks'
Tag:
type: object
properties:
id:
$ref: '#/components/schemas/TagId'
name:
$ref: '#/components/schemas/TagName'
tagLabel:
$ref: '#/components/schemas/TagLabel'
tagTypeId:
type: integer
format: int32
TeamRelationship:
type: object
properties:
data:
$ref: '#/components/schemas/TeamRelData'
links:
$ref: '#/components/schemas/TeamRelLinks'
UserSingle:
type: object
properties:
data:
$ref: '#/components/schemas/UserResource'
included:
type: array
items:
type: object
meta:
$ref: '#/components/schemas/UserReadMeta'
UserDeactivationPeriodRelToMany:
type: object
properties:
data:
type: arra
# --- truncated at 32 KB (48 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sedna/refs/heads/main/openapi/sedna-user-api-api-openapi.yml