Nexus
Nexus APIs
POST
/v1/organizations/{organizationId}/members
Add member to this organization
Parameters
| Name | In | Required | Description |
|---|---|---|---|
organizationId |
path | Yes |
Request body
Request payload
Example
{
"userId": "string",
"isMfaRequired": false
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
isMfaRequired
|
boolean
|
required | Is MFA required flag | — |
userId
|
string
|
required |
User id
minLength: 1 · maxLength: 40
|
— |
Example
{
"userId": "string",
"isMfaRequired": false
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
isMfaRequired
|
boolean
|
required | Is MFA required flag | — |
userId
|
string
|
required |
User id
minLength: 1 · maxLength: 40
|
— |
Example
{
"userId": "string",
"isMfaRequired": false
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
isMfaRequired
|
boolean
|
required | Is MFA required flag | — |
userId
|
string
|
required |
User id
minLength: 1 · maxLength: 40
|
— |
Example
{
"userId": "string",
"isMfaRequired": false
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
isMfaRequired
|
boolean
|
required | Is MFA required flag | — |
userId
|
string
|
required |
User id
minLength: 1 · maxLength: 40
|
— |
Example
{
"userId": "string",
"isMfaRequired": false
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
isMfaRequired
|
boolean
|
required | Is MFA required flag | — |
userId
|
string
|
required |
User id
minLength: 1 · maxLength: 40
|
— |
Example
{
"userId": "string",
"isMfaRequired": false
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
isMfaRequired
|
boolean
|
required | Is MFA required flag | — |
userId
|
string
|
required |
User id
minLength: 1 · maxLength: 40
|
— |
Example
{
"userId": "string",
"isMfaRequired": false
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
isMfaRequired
|
boolean
|
required | Is MFA required flag | — |
userId
|
string
|
required |
User id
minLength: 1 · maxLength: 40
|
— |
Example
{
"userId": "string",
"isMfaRequired": false
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
isMfaRequired
|
boolean
|
required | Is MFA required flag | — |
userId
|
string
|
required |
User id
minLength: 1 · maxLength: 40
|
— |
Responses
201
Example
{
"id": "string",
"user": {
"id": "string",
"type": "string",
"owner": {
"id": "string",
"type": "string",
"owner": {
"type": null,
"owner": null,
"organization": null,
"authenticationMethod": null,
"email-verification-status-type": null
},
"roles": [],
"created": "string",
"ownerId": "string",
"picture": "string",
"isActive": false,
"language": "string",
"memberOf": [],
"modified": "string",
"nickname": "string",
"username": "string",
"createdBy": "string",
"givenName": "string",
"attributes": [],
"customUpns": [],
"familyName": "string",
"identities": [],
"modifiedBy": "string",
"displayName": "Justin Buchanan",
"phoneNumber": "string",
"emailAddress": "justin@example.com",
"organization": {
"type": null
},
"isMfaDisabled": false,
"subscriptions": [],
"email-verified": false,
"organizationId": 0,
"mfaEnrollmentStatus": "string",
"authenticationMethod": "string",
"recoveryEmailAddress": "string",
"applicationDeployments": [],
"email-verify-sent-date": "string",
"email-verification-status-type": "string"
},
"roles": [
{
"id": "string",
"name": "string",
"expires": "string",
"description": "string"
}
],
"created": "string",
"ownerId": "string",
"picture": "string",
"isActive": false,
"language": "string",
"memberOf": [
{
"id": "string",
"user": null,
"roles": [],
"userId": "string",
"created": "string",
"isGuest": false,
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"isMfaRequired": false,
"organizationId": 0,
"organizationName": "string",
"isMembershipMfaRequired": false,
"organizationDisplayName": "string"
}
],
"modified": "string",
"nickname": "string",
"username": "string",
"createdBy": "string",
"givenName": "string",
"attributes": [
{
"id": 0,
"name": "string",
"value": "string",
"userId": "string",
"expires": "string"
}
],
"customUpns": [
{
"id": "string",
"userId": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"clientUpnKey": "string",
"customUpnValue": "string"
}
],
"familyName": "string",
"identities": [
{
"id": 0,
"groups": [],
"strategy": "string",
"azoUserId": "string",
"idpTenantId": 0,
"loginDomain": "string",
"azoTenantName": "string",
"idpTenantFqdn": "string",
"idpTenantName": "string",
"azoConnectionId": "string"
}
],
"modifiedBy": "string",
"displayName": "Justin Buchanan",
"phoneNumber": "string",
"emailAddress": "justin@example.com",
"organization": {
"id": 0,
"name": "string",
"type": "string",
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"isMfaDisabled": false,
"subscriptions": [
{
"id": 0,
"logs": [],
"type": "string",
"status": null,
"created": "string",
"details": "string",
"expires": "string",
"product": null,
"modified": "string",
"createdBy": "string",
"isEnabled": false,
"productId": 0,
"modifiedBy": "string",
"statusText": "string",
"description": "string",
"sfLicenseId": "string",
"organization": null,
"sfContractId": "string",
"customMetadata": null,
"organizationId": 0,
"readonlyMetadata": null,
"sfSubscriptionId": "string",
"applicationDeployments": []
}
],
"email-verified": false,
"organizationId": 0,
"mfaEnrollmentStatus": "string",
"authenticationMethod": "string",
"recoveryEmailAddress": "string",
"applicationDeployments": [
{
"id": 0,
"name": "string",
"steps": [],
"status": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"application": null,
"displayName": "string",
"maxUserCount": 0,
"subscription": null,
"applicationId": 0,
"configuration": "string",
"customMetadata": null,
"subscriptionId": 0,
"deploymentTarget": null,
"readonlyMetadata": null,
"statusResolution": "string",
"deploymentTargetId": 0
}
],
"email-verify-sent-date": "string",
"email-verification-status-type": "string"
},
"roles": [
{
"id": "string",
"name": "string",
"expires": "string",
"description": "string"
}
],
"userId": "string",
"created": "string",
"isGuest": false,
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"isMfaRequired": false,
"organizationId": 0,
"organizationName": "string",
"isMembershipMfaRequired": false,
"organizationDisplayName": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | When the record was created | — |
createdBy
|
string
|
nullable | Who created the record | — |
id
|
string
|
nullable | The member id | — |
isGuest
|
boolean
|
nullable | If the user is a guest or true member of the org. | — |
isMembershipMfaRequired
|
boolean
|
nullable | Gets a flag that indicates if MFA enrollment is required for the member. | — |
isMfaRequired
|
boolean
|
nullable | Gets a flag that indicates if MFA enrollment is required for organization | — |
modified
|
string (date-time)
|
nullable | The modified date | — |
modifiedBy
|
string
|
nullable | The modified by user id | — |
organizationDisplayName
|
string
|
nullable | The name of the organization | — |
organizationId
|
integer (int32)
|
nullable | The member organization id | — |
organizationName
|
string
|
nullable | The unique name of the organization | — |
roles
|
nullable | The roles the user has in the organization | — | |
user
|
— | — | — | |
userId
|
string
|
nullable | The member user id | — |
Example
{
"id": "string",
"user": {
"id": "string",
"type": "string",
"owner": {
"id": "string",
"type": "string",
"owner": {
"type": null,
"owner": null,
"organization": null,
"authenticationMethod": null,
"email-verification-status-type": null
},
"roles": [],
"created": "string",
"ownerId": "string",
"picture": "string",
"isActive": false,
"language": "string",
"memberOf": [],
"modified": "string",
"nickname": "string",
"username": "string",
"createdBy": "string",
"givenName": "string",
"attributes": [],
"customUpns": [],
"familyName": "string",
"identities": [],
"modifiedBy": "string",
"displayName": "Justin Buchanan",
"phoneNumber": "string",
"emailAddress": "justin@example.com",
"organization": {
"type": null
},
"isMfaDisabled": false,
"subscriptions": [],
"email-verified": false,
"organizationId": 0,
"mfaEnrollmentStatus": "string",
"authenticationMethod": "string",
"recoveryEmailAddress": "string",
"applicationDeployments": [],
"email-verify-sent-date": "string",
"email-verification-status-type": "string"
},
"roles": [
{
"id": "string",
"name": "string",
"expires": "string",
"description": "string"
}
],
"created": "string",
"ownerId": "string",
"picture": "string",
"isActive": false,
"language": "string",
"memberOf": [
{
"id": "string",
"user": null,
"roles": [],
"userId": "string",
"created": "string",
"isGuest": false,
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"isMfaRequired": false,
"organizationId": 0,
"organizationName": "string",
"isMembershipMfaRequired": false,
"organizationDisplayName": "string"
}
],
"modified": "string",
"nickname": "string",
"username": "string",
"createdBy": "string",
"givenName": "string",
"attributes": [
{
"id": 0,
"name": "string",
"value": "string",
"userId": "string",
"expires": "string"
}
],
"customUpns": [
{
"id": "string",
"userId": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"clientUpnKey": "string",
"customUpnValue": "string"
}
],
"familyName": "string",
"identities": [
{
"id": 0,
"groups": [],
"strategy": "string",
"azoUserId": "string",
"idpTenantId": 0,
"loginDomain": "string",
"azoTenantName": "string",
"idpTenantFqdn": "string",
"idpTenantName": "string",
"azoConnectionId": "string"
}
],
"modifiedBy": "string",
"displayName": "Justin Buchanan",
"phoneNumber": "string",
"emailAddress": "justin@example.com",
"organization": {
"id": 0,
"name": "string",
"type": "string",
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"isMfaDisabled": false,
"subscriptions": [
{
"id": 0,
"logs": [],
"type": "string",
"status": null,
"created": "string",
"details": "string",
"expires": "string",
"product": null,
"modified": "string",
"createdBy": "string",
"isEnabled": false,
"productId": 0,
"modifiedBy": "string",
"statusText": "string",
"description": "string",
"sfLicenseId": "string",
"organization": null,
"sfContractId": "string",
"customMetadata": null,
"organizationId": 0,
"readonlyMetadata": null,
"sfSubscriptionId": "string",
"applicationDeployments": []
}
],
"email-verified": false,
"organizationId": 0,
"mfaEnrollmentStatus": "string",
"authenticationMethod": "string",
"recoveryEmailAddress": "string",
"applicationDeployments": [
{
"id": 0,
"name": "string",
"steps": [],
"status": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"application": null,
"displayName": "string",
"maxUserCount": 0,
"subscription": null,
"applicationId": 0,
"configuration": "string",
"customMetadata": null,
"subscriptionId": 0,
"deploymentTarget": null,
"readonlyMetadata": null,
"statusResolution": "string",
"deploymentTargetId": 0
}
],
"email-verify-sent-date": "string",
"email-verification-status-type": "string"
},
"roles": [
{
"id": "string",
"name": "string",
"expires": "string",
"description": "string"
}
],
"userId": "string",
"created": "string",
"isGuest": false,
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"isMfaRequired": false,
"organizationId": 0,
"organizationName": "string",
"isMembershipMfaRequired": false,
"organizationDisplayName": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | When the record was created | — |
createdBy
|
string
|
nullable | Who created the record | — |
id
|
string
|
nullable | The member id | — |
isGuest
|
boolean
|
nullable | If the user is a guest or true member of the org. | — |
isMembershipMfaRequired
|
boolean
|
nullable | Gets a flag that indicates if MFA enrollment is required for the member. | — |
isMfaRequired
|
boolean
|
nullable | Gets a flag that indicates if MFA enrollment is required for organization | — |
modified
|
string (date-time)
|
nullable | The modified date | — |
modifiedBy
|
string
|
nullable | The modified by user id | — |
organizationDisplayName
|
string
|
nullable | The name of the organization | — |
organizationId
|
integer (int32)
|
nullable | The member organization id | — |
organizationName
|
string
|
nullable | The unique name of the organization | — |
roles
|
nullable | The roles the user has in the organization | — | |
user
|
— | — | — | |
userId
|
string
|
nullable | The member user id | — |
Example
{
"id": "string",
"user": {
"id": "string",
"type": "string",
"owner": {
"id": "string",
"type": "string",
"owner": {
"type": null,
"owner": null,
"organization": null,
"authenticationMethod": null,
"email-verification-status-type": null
},
"roles": [],
"created": "string",
"ownerId": "string",
"picture": "string",
"isActive": false,
"language": "string",
"memberOf": [],
"modified": "string",
"nickname": "string",
"username": "string",
"createdBy": "string",
"givenName": "string",
"attributes": [],
"customUpns": [],
"familyName": "string",
"identities": [],
"modifiedBy": "string",
"displayName": "Justin Buchanan",
"phoneNumber": "string",
"emailAddress": "justin@example.com",
"organization": {
"type": null
},
"isMfaDisabled": false,
"subscriptions": [],
"email-verified": false,
"organizationId": 0,
"mfaEnrollmentStatus": "string",
"authenticationMethod": "string",
"recoveryEmailAddress": "string",
"applicationDeployments": [],
"email-verify-sent-date": "string",
"email-verification-status-type": "string"
},
"roles": [
{
"id": "string",
"name": "string",
"expires": "string",
"description": "string"
}
],
"created": "string",
"ownerId": "string",
"picture": "string",
"isActive": false,
"language": "string",
"memberOf": [
{
"id": "string",
"user": null,
"roles": [],
"userId": "string",
"created": "string",
"isGuest": false,
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"isMfaRequired": false,
"organizationId": 0,
"organizationName": "string",
"isMembershipMfaRequired": false,
"organizationDisplayName": "string"
}
],
"modified": "string",
"nickname": "string",
"username": "string",
"createdBy": "string",
"givenName": "string",
"attributes": [
{
"id": 0,
"name": "string",
"value": "string",
"userId": "string",
"expires": "string"
}
],
"customUpns": [
{
"id": "string",
"userId": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"clientUpnKey": "string",
"customUpnValue": "string"
}
],
"familyName": "string",
"identities": [
{
"id": 0,
"groups": [],
"strategy": "string",
"azoUserId": "string",
"idpTenantId": 0,
"loginDomain": "string",
"azoTenantName": "string",
"idpTenantFqdn": "string",
"idpTenantName": "string",
"azoConnectionId": "string"
}
],
"modifiedBy": "string",
"displayName": "Justin Buchanan",
"phoneNumber": "string",
"emailAddress": "justin@example.com",
"organization": {
"id": 0,
"name": "string",
"type": "string",
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"isMfaDisabled": false,
"subscriptions": [
{
"id": 0,
"logs": [],
"type": "string",
"status": null,
"created": "string",
"details": "string",
"expires": "string",
"product": null,
"modified": "string",
"createdBy": "string",
"isEnabled": false,
"productId": 0,
"modifiedBy": "string",
"statusText": "string",
"description": "string",
"sfLicenseId": "string",
"organization": null,
"sfContractId": "string",
"customMetadata": null,
"organizationId": 0,
"readonlyMetadata": null,
"sfSubscriptionId": "string",
"applicationDeployments": []
}
],
"email-verified": false,
"organizationId": 0,
"mfaEnrollmentStatus": "string",
"authenticationMethod": "string",
"recoveryEmailAddress": "string",
"applicationDeployments": [
{
"id": 0,
"name": "string",
"steps": [],
"status": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"application": null,
"displayName": "string",
"maxUserCount": 0,
"subscription": null,
"applicationId": 0,
"configuration": "string",
"customMetadata": null,
"subscriptionId": 0,
"deploymentTarget": null,
"readonlyMetadata": null,
"statusResolution": "string",
"deploymentTargetId": 0
}
],
"email-verify-sent-date": "string",
"email-verification-status-type": "string"
},
"roles": [
{
"id": "string",
"name": "string",
"expires": "string",
"description": "string"
}
],
"userId": "string",
"created": "string",
"isGuest": false,
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"isMfaRequired": false,
"organizationId": 0,
"organizationName": "string",
"isMembershipMfaRequired": false,
"organizationDisplayName": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | When the record was created | — |
createdBy
|
string
|
nullable | Who created the record | — |
id
|
string
|
nullable | The member id | — |
isGuest
|
boolean
|
nullable | If the user is a guest or true member of the org. | — |
isMembershipMfaRequired
|
boolean
|
nullable | Gets a flag that indicates if MFA enrollment is required for the member. | — |
isMfaRequired
|
boolean
|
nullable | Gets a flag that indicates if MFA enrollment is required for organization | — |
modified
|
string (date-time)
|
nullable | The modified date | — |
modifiedBy
|
string
|
nullable | The modified by user id | — |
organizationDisplayName
|
string
|
nullable | The name of the organization | — |
organizationId
|
integer (int32)
|
nullable | The member organization id | — |
organizationName
|
string
|
nullable | The unique name of the organization | — |
roles
|
nullable | The roles the user has in the organization | — | |
user
|
— | — | — | |
userId
|
string
|
nullable | The member user id | — |
Example
{
"id": "string",
"user": {
"id": "string",
"type": "string",
"owner": {
"id": "string",
"type": "string",
"owner": {
"type": null,
"owner": null,
"organization": null,
"authenticationMethod": null,
"email-verification-status-type": null
},
"roles": [],
"created": "string",
"ownerId": "string",
"picture": "string",
"isActive": false,
"language": "string",
"memberOf": [],
"modified": "string",
"nickname": "string",
"username": "string",
"createdBy": "string",
"givenName": "string",
"attributes": [],
"customUpns": [],
"familyName": "string",
"identities": [],
"modifiedBy": "string",
"displayName": "Justin Buchanan",
"phoneNumber": "string",
"emailAddress": "justin@example.com",
"organization": {
"type": null
},
"isMfaDisabled": false,
"subscriptions": [],
"email-verified": false,
"organizationId": 0,
"mfaEnrollmentStatus": "string",
"authenticationMethod": "string",
"recoveryEmailAddress": "string",
"applicationDeployments": [],
"email-verify-sent-date": "string",
"email-verification-status-type": "string"
},
"roles": [
{
"id": "string",
"name": "string",
"expires": "string",
"description": "string"
}
],
"created": "string",
"ownerId": "string",
"picture": "string",
"isActive": false,
"language": "string",
"memberOf": [
{
"id": "string",
"user": null,
"roles": [],
"userId": "string",
"created": "string",
"isGuest": false,
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"isMfaRequired": false,
"organizationId": 0,
"organizationName": "string",
"isMembershipMfaRequired": false,
"organizationDisplayName": "string"
}
],
"modified": "string",
"nickname": "string",
"username": "string",
"createdBy": "string",
"givenName": "string",
"attributes": [
{
"id": 0,
"name": "string",
"value": "string",
"userId": "string",
"expires": "string"
}
],
"customUpns": [
{
"id": "string",
"userId": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"clientUpnKey": "string",
"customUpnValue": "string"
}
],
"familyName": "string",
"identities": [
{
"id": 0,
"groups": [],
"strategy": "string",
"azoUserId": "string",
"idpTenantId": 0,
"loginDomain": "string",
"azoTenantName": "string",
"idpTenantFqdn": "string",
"idpTenantName": "string",
"azoConnectionId": "string"
}
],
"modifiedBy": "string",
"displayName": "Justin Buchanan",
"phoneNumber": "string",
"emailAddress": "justin@example.com",
"organization": {
"id": 0,
"name": "string",
"type": "string",
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"isMfaDisabled": false,
"subscriptions": [
{
"id": 0,
"logs": [],
"type": "string",
"status": null,
"created": "string",
"details": "string",
"expires": "string",
"product": null,
"modified": "string",
"createdBy": "string",
"isEnabled": false,
"productId": 0,
"modifiedBy": "string",
"statusText": "string",
"description": "string",
"sfLicenseId": "string",
"organization": null,
"sfContractId": "string",
"customMetadata": null,
"organizationId": 0,
"readonlyMetadata": null,
"sfSubscriptionId": "string",
"applicationDeployments": []
}
],
"email-verified": false,
"organizationId": 0,
"mfaEnrollmentStatus": "string",
"authenticationMethod": "string",
"recoveryEmailAddress": "string",
"applicationDeployments": [
{
"id": 0,
"name": "string",
"steps": [],
"status": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"application": null,
"displayName": "string",
"maxUserCount": 0,
"subscription": null,
"applicationId": 0,
"configuration": "string",
"customMetadata": null,
"subscriptionId": 0,
"deploymentTarget": null,
"readonlyMetadata": null,
"statusResolution": "string",
"deploymentTargetId": 0
}
],
"email-verify-sent-date": "string",
"email-verification-status-type": "string"
},
"roles": [
{
"id": "string",
"name": "string",
"expires": "string",
"description": "string"
}
],
"userId": "string",
"created": "string",
"isGuest": false,
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"isMfaRequired": false,
"organizationId": 0,
"organizationName": "string",
"isMembershipMfaRequired": false,
"organizationDisplayName": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | When the record was created | — |
createdBy
|
string
|
nullable | Who created the record | — |
id
|
string
|
nullable | The member id | — |
isGuest
|
boolean
|
nullable | If the user is a guest or true member of the org. | — |
isMembershipMfaRequired
|
boolean
|
nullable | Gets a flag that indicates if MFA enrollment is required for the member. | — |
isMfaRequired
|
boolean
|
nullable | Gets a flag that indicates if MFA enrollment is required for organization | — |
modified
|
string (date-time)
|
nullable | The modified date | — |
modifiedBy
|
string
|
nullable | The modified by user id | — |
organizationDisplayName
|
string
|
nullable | The name of the organization | — |
organizationId
|
integer (int32)
|
nullable | The member organization id | — |
organizationName
|
string
|
nullable | The unique name of the organization | — |
roles
|
nullable | The roles the user has in the organization | — | |
user
|
— | — | — | |
userId
|
string
|
nullable | The member user id | — |
Example
{
"id": "string",
"user": {
"id": "string",
"type": "string",
"owner": {
"id": "string",
"type": "string",
"owner": {
"type": null,
"owner": null,
"organization": null,
"authenticationMethod": null,
"email-verification-status-type": null
},
"roles": [],
"created": "string",
"ownerId": "string",
"picture": "string",
"isActive": false,
"language": "string",
"memberOf": [],
"modified": "string",
"nickname": "string",
"username": "string",
"createdBy": "string",
"givenName": "string",
"attributes": [],
"customUpns": [],
"familyName": "string",
"identities": [],
"modifiedBy": "string",
"displayName": "Justin Buchanan",
"phoneNumber": "string",
"emailAddress": "justin@example.com",
"organization": {
"type": null
},
"isMfaDisabled": false,
"subscriptions": [],
"email-verified": false,
"organizationId": 0,
"mfaEnrollmentStatus": "string",
"authenticationMethod": "string",
"recoveryEmailAddress": "string",
"applicationDeployments": [],
"email-verify-sent-date": "string",
"email-verification-status-type": "string"
},
"roles": [
{
"id": "string",
"name": "string",
"expires": "string",
"description": "string"
}
],
"created": "string",
"ownerId": "string",
"picture": "string",
"isActive": false,
"language": "string",
"memberOf": [
{
"id": "string",
"user": null,
"roles": [],
"userId": "string",
"created": "string",
"isGuest": false,
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"isMfaRequired": false,
"organizationId": 0,
"organizationName": "string",
"isMembershipMfaRequired": false,
"organizationDisplayName": "string"
}
],
"modified": "string",
"nickname": "string",
"username": "string",
"createdBy": "string",
"givenName": "string",
"attributes": [
{
"id": 0,
"name": "string",
"value": "string",
"userId": "string",
"expires": "string"
}
],
"customUpns": [
{
"id": "string",
"userId": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"clientUpnKey": "string",
"customUpnValue": "string"
}
],
"familyName": "string",
"identities": [
{
"id": 0,
"groups": [],
"strategy": "string",
"azoUserId": "string",
"idpTenantId": 0,
"loginDomain": "string",
"azoTenantName": "string",
"idpTenantFqdn": "string",
"idpTenantName": "string",
"azoConnectionId": "string"
}
],
"modifiedBy": "string",
"displayName": "Justin Buchanan",
"phoneNumber": "string",
"emailAddress": "justin@example.com",
"organization": {
"id": 0,
"name": "string",
"type": "string",
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"isMfaDisabled": false,
"subscriptions": [
{
"id": 0,
"logs": [],
"type": "string",
"status": null,
"created": "string",
"details": "string",
"expires": "string",
"product": null,
"modified": "string",
"createdBy": "string",
"isEnabled": false,
"productId": 0,
"modifiedBy": "string",
"statusText": "string",
"description": "string",
"sfLicenseId": "string",
"organization": null,
"sfContractId": "string",
"customMetadata": null,
"organizationId": 0,
"readonlyMetadata": null,
"sfSubscriptionId": "string",
"applicationDeployments": []
}
],
"email-verified": false,
"organizationId": 0,
"mfaEnrollmentStatus": "string",
"authenticationMethod": "string",
"recoveryEmailAddress": "string",
"applicationDeployments": [
{
"id": 0,
"name": "string",
"steps": [],
"status": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"application": null,
"displayName": "string",
"maxUserCount": 0,
"subscription": null,
"applicationId": 0,
"configuration": "string",
"customMetadata": null,
"subscriptionId": 0,
"deploymentTarget": null,
"readonlyMetadata": null,
"statusResolution": "string",
"deploymentTargetId": 0
}
],
"email-verify-sent-date": "string",
"email-verification-status-type": "string"
},
"roles": [
{
"id": "string",
"name": "string",
"expires": "string",
"description": "string"
}
],
"userId": "string",
"created": "string",
"isGuest": false,
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"isMfaRequired": false,
"organizationId": 0,
"organizationName": "string",
"isMembershipMfaRequired": false,
"organizationDisplayName": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | When the record was created | — |
createdBy
|
string
|
nullable | Who created the record | — |
id
|
string
|
nullable | The member id | — |
isGuest
|
boolean
|
nullable | If the user is a guest or true member of the org. | — |
isMembershipMfaRequired
|
boolean
|
nullable | Gets a flag that indicates if MFA enrollment is required for the member. | — |
isMfaRequired
|
boolean
|
nullable | Gets a flag that indicates if MFA enrollment is required for organization | — |
modified
|
string (date-time)
|
nullable | The modified date | — |
modifiedBy
|
string
|
nullable | The modified by user id | — |
organizationDisplayName
|
string
|
nullable | The name of the organization | — |
organizationId
|
integer (int32)
|
nullable | The member organization id | — |
organizationName
|
string
|
nullable | The unique name of the organization | — |
roles
|
nullable | The roles the user has in the organization | — | |
user
|
— | — | — | |
userId
|
string
|
nullable | The member user id | — |
Example
{
"id": "string",
"user": {
"id": "string",
"type": "string",
"owner": {
"id": "string",
"type": "string",
"owner": {
"type": null,
"owner": null,
"organization": null,
"authenticationMethod": null,
"email-verification-status-type": null
},
"roles": [],
"created": "string",
"ownerId": "string",
"picture": "string",
"isActive": false,
"language": "string",
"memberOf": [],
"modified": "string",
"nickname": "string",
"username": "string",
"createdBy": "string",
"givenName": "string",
"attributes": [],
"customUpns": [],
"familyName": "string",
"identities": [],
"modifiedBy": "string",
"displayName": "Justin Buchanan",
"phoneNumber": "string",
"emailAddress": "justin@example.com",
"organization": {
"type": null
},
"isMfaDisabled": false,
"subscriptions": [],
"email-verified": false,
"organizationId": 0,
"mfaEnrollmentStatus": "string",
"authenticationMethod": "string",
"recoveryEmailAddress": "string",
"applicationDeployments": [],
"email-verify-sent-date": "string",
"email-verification-status-type": "string"
},
"roles": [
{
"id": "string",
"name": "string",
"expires": "string",
"description": "string"
}
],
"created": "string",
"ownerId": "string",
"picture": "string",
"isActive": false,
"language": "string",
"memberOf": [
{
"id": "string",
"user": null,
"roles": [],
"userId": "string",
"created": "string",
"isGuest": false,
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"isMfaRequired": false,
"organizationId": 0,
"organizationName": "string",
"isMembershipMfaRequired": false,
"organizationDisplayName": "string"
}
],
"modified": "string",
"nickname": "string",
"username": "string",
"createdBy": "string",
"givenName": "string",
"attributes": [
{
"id": 0,
"name": "string",
"value": "string",
"userId": "string",
"expires": "string"
}
],
"customUpns": [
{
"id": "string",
"userId": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"clientUpnKey": "string",
"customUpnValue": "string"
}
],
"familyName": "string",
"identities": [
{
"id": 0,
"groups": [],
"strategy": "string",
"azoUserId": "string",
"idpTenantId": 0,
"loginDomain": "string",
"azoTenantName": "string",
"idpTenantFqdn": "string",
"idpTenantName": "string",
"azoConnectionId": "string"
}
],
"modifiedBy": "string",
"displayName": "Justin Buchanan",
"phoneNumber": "string",
"emailAddress": "justin@example.com",
"organization": {
"id": 0,
"name": "string",
"type": "string",
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"isMfaDisabled": false,
"subscriptions": [
{
"id": 0,
"logs": [],
"type": "string",
"status": null,
"created": "string",
"details": "string",
"expires": "string",
"product": null,
"modified": "string",
"createdBy": "string",
"isEnabled": false,
"productId": 0,
"modifiedBy": "string",
"statusText": "string",
"description": "string",
"sfLicenseId": "string",
"organization": null,
"sfContractId": "string",
"customMetadata": null,
"organizationId": 0,
"readonlyMetadata": null,
"sfSubscriptionId": "string",
"applicationDeployments": []
}
],
"email-verified": false,
"organizationId": 0,
"mfaEnrollmentStatus": "string",
"authenticationMethod": "string",
"recoveryEmailAddress": "string",
"applicationDeployments": [
{
"id": 0,
"name": "string",
"steps": [],
"status": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"application": null,
"displayName": "string",
"maxUserCount": 0,
"subscription": null,
"applicationId": 0,
"configuration": "string",
"customMetadata": null,
"subscriptionId": 0,
"deploymentTarget": null,
"readonlyMetadata": null,
"statusResolution": "string",
"deploymentTargetId": 0
}
],
"email-verify-sent-date": "string",
"email-verification-status-type": "string"
},
"roles": [
{
"id": "string",
"name": "string",
"expires": "string",
"description": "string"
}
],
"userId": "string",
"created": "string",
"isGuest": false,
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"isMfaRequired": false,
"organizationId": 0,
"organizationName": "string",
"isMembershipMfaRequired": false,
"organizationDisplayName": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | When the record was created | — |
createdBy
|
string
|
nullable | Who created the record | — |
id
|
string
|
nullable | The member id | — |
isGuest
|
boolean
|
nullable | If the user is a guest or true member of the org. | — |
isMembershipMfaRequired
|
boolean
|
nullable | Gets a flag that indicates if MFA enrollment is required for the member. | — |
isMfaRequired
|
boolean
|
nullable | Gets a flag that indicates if MFA enrollment is required for organization | — |
modified
|
string (date-time)
|
nullable | The modified date | — |
modifiedBy
|
string
|
nullable | The modified by user id | — |
organizationDisplayName
|
string
|
nullable | The name of the organization | — |
organizationId
|
integer (int32)
|
nullable | The member organization id | — |
organizationName
|
string
|
nullable | The unique name of the organization | — |
roles
|
nullable | The roles the user has in the organization | — | |
user
|
— | — | — | |
userId
|
string
|
nullable | The member user id | — |
Example
{
"id": "string",
"user": {
"id": "string",
"type": "string",
"owner": {
"id": "string",
"type": "string",
"owner": {
"type": null,
"owner": null,
"organization": null,
"authenticationMethod": null,
"email-verification-status-type": null
},
"roles": [],
"created": "string",
"ownerId": "string",
"picture": "string",
"isActive": false,
"language": "string",
"memberOf": [],
"modified": "string",
"nickname": "string",
"username": "string",
"createdBy": "string",
"givenName": "string",
"attributes": [],
"customUpns": [],
"familyName": "string",
"identities": [],
"modifiedBy": "string",
"displayName": "Justin Buchanan",
"phoneNumber": "string",
"emailAddress": "justin@example.com",
"organization": {
"type": null
},
"isMfaDisabled": false,
"subscriptions": [],
"email-verified": false,
"organizationId": 0,
"mfaEnrollmentStatus": "string",
"authenticationMethod": "string",
"recoveryEmailAddress": "string",
"applicationDeployments": [],
"email-verify-sent-date": "string",
"email-verification-status-type": "string"
},
"roles": [
{
"id": "string",
"name": "string",
"expires": "string",
"description": "string"
}
],
"created": "string",
"ownerId": "string",
"picture": "string",
"isActive": false,
"language": "string",
"memberOf": [
{
"id": "string",
"user": null,
"roles": [],
"userId": "string",
"created": "string",
"isGuest": false,
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"isMfaRequired": false,
"organizationId": 0,
"organizationName": "string",
"isMembershipMfaRequired": false,
"organizationDisplayName": "string"
}
],
"modified": "string",
"nickname": "string",
"username": "string",
"createdBy": "string",
"givenName": "string",
"attributes": [
{
"id": 0,
"name": "string",
"value": "string",
"userId": "string",
"expires": "string"
}
],
"customUpns": [
{
"id": "string",
"userId": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"clientUpnKey": "string",
"customUpnValue": "string"
}
],
"familyName": "string",
"identities": [
{
"id": 0,
"groups": [],
"strategy": "string",
"azoUserId": "string",
"idpTenantId": 0,
"loginDomain": "string",
"azoTenantName": "string",
"idpTenantFqdn": "string",
"idpTenantName": "string",
"azoConnectionId": "string"
}
],
"modifiedBy": "string",
"displayName": "Justin Buchanan",
"phoneNumber": "string",
"emailAddress": "justin@example.com",
"organization": {
"id": 0,
"name": "string",
"type": "string",
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"isMfaDisabled": false,
"subscriptions": [
{
"id": 0,
"logs": [],
"type": "string",
"status": null,
"created": "string",
"details": "string",
"expires": "string",
"product": null,
"modified": "string",
"createdBy": "string",
"isEnabled": false,
"productId": 0,
"modifiedBy": "string",
"statusText": "string",
"description": "string",
"sfLicenseId": "string",
"organization": null,
"sfContractId": "string",
"customMetadata": null,
"organizationId": 0,
"readonlyMetadata": null,
"sfSubscriptionId": "string",
"applicationDeployments": []
}
],
"email-verified": false,
"organizationId": 0,
"mfaEnrollmentStatus": "string",
"authenticationMethod": "string",
"recoveryEmailAddress": "string",
"applicationDeployments": [
{
"id": 0,
"name": "string",
"steps": [],
"status": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"application": null,
"displayName": "string",
"maxUserCount": 0,
"subscription": null,
"applicationId": 0,
"configuration": "string",
"customMetadata": null,
"subscriptionId": 0,
"deploymentTarget": null,
"readonlyMetadata": null,
"statusResolution": "string",
"deploymentTargetId": 0
}
],
"email-verify-sent-date": "string",
"email-verification-status-type": "string"
},
"roles": [
{
"id": "string",
"name": "string",
"expires": "string",
"description": "string"
}
],
"userId": "string",
"created": "string",
"isGuest": false,
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"isMfaRequired": false,
"organizationId": 0,
"organizationName": "string",
"isMembershipMfaRequired": false,
"organizationDisplayName": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | When the record was created | — |
createdBy
|
string
|
nullable | Who created the record | — |
id
|
string
|
nullable | The member id | — |
isGuest
|
boolean
|
nullable | If the user is a guest or true member of the org. | — |
isMembershipMfaRequired
|
boolean
|
nullable | Gets a flag that indicates if MFA enrollment is required for the member. | — |
isMfaRequired
|
boolean
|
nullable | Gets a flag that indicates if MFA enrollment is required for organization | — |
modified
|
string (date-time)
|
nullable | The modified date | — |
modifiedBy
|
string
|
nullable | The modified by user id | — |
organizationDisplayName
|
string
|
nullable | The name of the organization | — |
organizationId
|
integer (int32)
|
nullable | The member organization id | — |
organizationName
|
string
|
nullable | The unique name of the organization | — |
roles
|
nullable | The roles the user has in the organization | — | |
user
|
— | — | — | |
userId
|
string
|
nullable | The member user id | — |
Security
Authentication is required for this operation.
Source: default
Requirements (any one option may satisfy)
- Bearer and ApplicationToken
- Basic