Nexus
Nexus APIs
POST
/v1/organizations/{organizationId}/members/import
Process bulk import of new organization members (or new users into organization) by an asynchronous background service which will notify requester via email when finished
Parameters
| Name | In | Required | Description |
|---|---|---|---|
organizationId |
path | Yes |
Request body
Request payload
Example
{
"id": "string",
"importDate": "string",
"newMembers": [
{
"givenName": "string",
"makeAdmin": false,
"familyName": "string",
"displayName": "string",
"emailAddress": "string",
"isMfaDisabled": false,
"recoveryEmail": "string"
}
],
"importFilename": "string",
"organizationId": 0,
"importingUserId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
id
|
string
|
required |
Id of this particular import model
minLength: 1
|
— |
importDate
|
string (date-time)
|
required | Date of import model | — |
importFilename
|
string
|
required |
Name of file uploaded for import
minLength: 1
|
— |
importingUserId
|
string
|
required |
Name of user calling the model import endpoint
minLength: 1
|
— |
newMembers
|
required | Collection of new member information to be imported as users (if necessary) and members | — | |
organizationId
|
integer (int32)
|
required | OrganizationId into which user | — |
Example
{
"id": "string",
"importDate": "string",
"newMembers": [
{
"givenName": "string",
"makeAdmin": false,
"familyName": "string",
"displayName": "string",
"emailAddress": "string",
"isMfaDisabled": false,
"recoveryEmail": "string"
}
],
"importFilename": "string",
"organizationId": 0,
"importingUserId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
id
|
string
|
required |
Id of this particular import model
minLength: 1
|
— |
importDate
|
string (date-time)
|
required | Date of import model | — |
importFilename
|
string
|
required |
Name of file uploaded for import
minLength: 1
|
— |
importingUserId
|
string
|
required |
Name of user calling the model import endpoint
minLength: 1
|
— |
newMembers
|
required | Collection of new member information to be imported as users (if necessary) and members | — | |
organizationId
|
integer (int32)
|
required | OrganizationId into which user | — |
Example
{
"id": "string",
"importDate": "string",
"newMembers": [
{
"givenName": "string",
"makeAdmin": false,
"familyName": "string",
"displayName": "string",
"emailAddress": "string",
"isMfaDisabled": false,
"recoveryEmail": "string"
}
],
"importFilename": "string",
"organizationId": 0,
"importingUserId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
id
|
string
|
required |
Id of this particular import model
minLength: 1
|
— |
importDate
|
string (date-time)
|
required | Date of import model | — |
importFilename
|
string
|
required |
Name of file uploaded for import
minLength: 1
|
— |
importingUserId
|
string
|
required |
Name of user calling the model import endpoint
minLength: 1
|
— |
newMembers
|
required | Collection of new member information to be imported as users (if necessary) and members | — | |
organizationId
|
integer (int32)
|
required | OrganizationId into which user | — |
Example
{
"id": "string",
"importDate": "string",
"newMembers": [
{
"givenName": "string",
"makeAdmin": false,
"familyName": "string",
"displayName": "string",
"emailAddress": "string",
"isMfaDisabled": false,
"recoveryEmail": "string"
}
],
"importFilename": "string",
"organizationId": 0,
"importingUserId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
id
|
string
|
required |
Id of this particular import model
minLength: 1
|
— |
importDate
|
string (date-time)
|
required | Date of import model | — |
importFilename
|
string
|
required |
Name of file uploaded for import
minLength: 1
|
— |
importingUserId
|
string
|
required |
Name of user calling the model import endpoint
minLength: 1
|
— |
newMembers
|
required | Collection of new member information to be imported as users (if necessary) and members | — | |
organizationId
|
integer (int32)
|
required | OrganizationId into which user | — |
Example
{
"id": "string",
"importDate": "string",
"newMembers": [
{
"givenName": "string",
"makeAdmin": false,
"familyName": "string",
"displayName": "string",
"emailAddress": "string",
"isMfaDisabled": false,
"recoveryEmail": "string"
}
],
"importFilename": "string",
"organizationId": 0,
"importingUserId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
id
|
string
|
required |
Id of this particular import model
minLength: 1
|
— |
importDate
|
string (date-time)
|
required | Date of import model | — |
importFilename
|
string
|
required |
Name of file uploaded for import
minLength: 1
|
— |
importingUserId
|
string
|
required |
Name of user calling the model import endpoint
minLength: 1
|
— |
newMembers
|
required | Collection of new member information to be imported as users (if necessary) and members | — | |
organizationId
|
integer (int32)
|
required | OrganizationId into which user | — |
Example
{
"id": "string",
"importDate": "string",
"newMembers": [
{
"givenName": "string",
"makeAdmin": false,
"familyName": "string",
"displayName": "string",
"emailAddress": "string",
"isMfaDisabled": false,
"recoveryEmail": "string"
}
],
"importFilename": "string",
"organizationId": 0,
"importingUserId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
id
|
string
|
required |
Id of this particular import model
minLength: 1
|
— |
importDate
|
string (date-time)
|
required | Date of import model | — |
importFilename
|
string
|
required |
Name of file uploaded for import
minLength: 1
|
— |
importingUserId
|
string
|
required |
Name of user calling the model import endpoint
minLength: 1
|
— |
newMembers
|
required | Collection of new member information to be imported as users (if necessary) and members | — | |
organizationId
|
integer (int32)
|
required | OrganizationId into which user | — |
Example
{
"id": "string",
"importDate": "string",
"newMembers": [
{
"givenName": "string",
"makeAdmin": false,
"familyName": "string",
"displayName": "string",
"emailAddress": "string",
"isMfaDisabled": false,
"recoveryEmail": "string"
}
],
"importFilename": "string",
"organizationId": 0,
"importingUserId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
id
|
string
|
required |
Id of this particular import model
minLength: 1
|
— |
importDate
|
string (date-time)
|
required | Date of import model | — |
importFilename
|
string
|
required |
Name of file uploaded for import
minLength: 1
|
— |
importingUserId
|
string
|
required |
Name of user calling the model import endpoint
minLength: 1
|
— |
newMembers
|
required | Collection of new member information to be imported as users (if necessary) and members | — | |
organizationId
|
integer (int32)
|
required | OrganizationId into which user | — |
Example
{
"id": "string",
"importDate": "string",
"newMembers": [
{
"givenName": "string",
"makeAdmin": false,
"familyName": "string",
"displayName": "string",
"emailAddress": "string",
"isMfaDisabled": false,
"recoveryEmail": "string"
}
],
"importFilename": "string",
"organizationId": 0,
"importingUserId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
id
|
string
|
required |
Id of this particular import model
minLength: 1
|
— |
importDate
|
string (date-time)
|
required | Date of import model | — |
importFilename
|
string
|
required |
Name of file uploaded for import
minLength: 1
|
— |
importingUserId
|
string
|
required |
Name of user calling the model import endpoint
minLength: 1
|
— |
newMembers
|
required | Collection of new member information to be imported as users (if necessary) and members | — | |
organizationId
|
integer (int32)
|
required | OrganizationId into which user | — |
Responses
202
Accepted
400
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Security
Authentication is required for this operation.
Source: default
Requirements (any one option may satisfy)
- Bearer and ApplicationToken
- Basic