There are various user personas within the SEI Trade workflow. The Users API allows SEI clients to create, read, update, and delete users within the application.
This API call creates a User in SEI Trade.
header Parameters
Authorization required | string access_token value obtained from the Token endpoint.This is passed as "Bearer access_token " |
AppKey required | string This is the Consumer Key provided during the App Registration process and is used to identify the user's application. |
Content-Type required | string This is the content type of the payload being passed. Valid value is application/json. |
X-SEIC-CURRENT-USER-CONTEXT | string Email address of the user authenticated into the application to view data. |
Request Body schema: application/json
userId required | string The Id that may be used to refer to the user. |
emailAddress required | string The email address of the user. |
firstName | string The first name for the financial advisor, investor,manager or contact or third party |
lastName | string The last name of the user. |
firm required | string The firm of the user |
Array of objects (Role) The role(s) associated with the user. |
Responses
Request samples
- Payload
{- "userId": "string",
- "emailAddress": "string",
- "firstName": "string",
- "lastName": "string",
- "firm": "string",
- "userRoles": [
- {
- "roleName": "string",
- "groupAssociations": [
- "string"
]
}
]
}
Response samples
- 201
- 400
- 401
- 403
- 404
- 500
{- "userId": "string",
- "emailAddress": "string",
- "firstName": "string",
- "lastName": "string",
- "firm": "string",
- "userRoles": [
- {
- "roleName": "string",
- "groupAssociations": [
- "string"
]
}
]
}
This API call gets a User in SEI Trade.
path Parameters
userId required | string The identifier of the user for which you are retrieving data. |
header Parameters
Authorization required | string access_token value obtained from the Token endpoint.This is passed as "Bearer access_token " |
AppKey required | string This is the Consumer Key provided during the App Registration process and is used to identify the user's application. |
Content-Type required | string This is the content type of the payload being passed. Valid value is application/json. |
X-SEIC-CURRENT-USER-CONTEXT | string Email address of the user authenticated into the application to view data. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "userId": "string",
- "emailAddress": "string",
- "firstName": "string",
- "lastName": "string",
- "firm": "string",
- "userRoles": [
- {
- "roleName": "string",
- "groupAssociations": [
- "string"
]
}
]
}
This API call updates a User in SEI Trade.
path Parameters
userId required | string The identifier of the user for which you changing data. |
header Parameters
Authorization required | string access_token value obtained from the Token endpoint.This is passed as "Bearer access_token " |
AppKey required | string This is the Consumer Key provided during the App Registration process and is used to identify the user's application. |
Content-Type required | string This is the content type of the payload being passed. Valid value is application/json. |
X-SEIC-CURRENT-USER-CONTEXT | string Email address of the user authenticated into the application to view data. |
Request Body schema: application/json
userId required | string The Id that may be used to refer to the user. |
emailAddress required | string The email address of the user. |
firstName | string The first name for the financial advisor, investor,manager or contact or third party |
lastName | string The last name of the user. |
firm required | string The firm of the user |
Array of objects (Role) The role(s) associated with the user. |
Responses
Request samples
- Payload
{- "userId": "string",
- "emailAddress": "string",
- "firstName": "string",
- "lastName": "string",
- "firm": "string",
- "userRoles": [
- {
- "roleName": "string",
- "groupAssociations": [
- "string"
]
}
]
}
Response samples
- 201
- 400
- 401
- 403
- 404
- 500
{- "userId": "string",
- "emailAddress": "string",
- "firstName": "string",
- "lastName": "string",
- "firm": "string",
- "userRoles": [
- {
- "roleName": "string",
- "groupAssociations": [
- "string"
]
}
]
}
This API call deletes a User in SEI Trade.
path Parameters
userId required | string Identifier of User to Delete. |
header Parameters
Authorization required | string access_token value obtained from the Token endpoint.This is passed as "Bearer access_token " |
AppKey required | string This is the Consumer Key provided during the App Registration process and is used to identify the user's application. |
Content-Type required | string This is the content type of the payload being passed. Valid value is application/json. |
X-SEIC-CURRENT-USER-CONTEXT | string Email address of the user authenticated into the application to view data. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "requestType": "Delete",
- "result": "Successfully deleted User Data for [jdoe@seic.com].",
- "message": "string"
}