Users

List all users attached to the tenant

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/admin/users

Returns all back-office users with access to this tenant.

Authorization

Requires tenant.access:read scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Responses

200

Users returned.

text/plainapplication/jsontext/json

Tenant-scoped user representation.

idstring · min: 1Required

User identifier.

emailstring · min: 1Required

User email address.

namestring · nullableOptional

Display name.

blockedbooleanOptional

True when the account is blocked.

lastLoginstring · nullableOptional

Last login timestamp.

tenantRolestring · nullableOptional

Tenant role assigned to the user.

get

/api/{tenantId}/admin/users

HTTPcURLJavaScriptPython

GET /api/{tenantId}/admin/users HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Users returned.

[
  {
    "id": "text",
    "email": "text",
    "name": null,
    "blocked": true,
    "lastLogin": null,
    "tenantRole": null
  }
]

Create a new user or attach an existing user to the tenant, unless already attached

post

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/admin/users

Creates a new Auth0 user or attaches an existing one to this tenant. If the user already has access to the tenant (a valid role), returns HTTP 409 Conflict.

Authorization

Requires tenant.access:write scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Body

application/jsontext/jsonapplication/*+json

Request payload for creating a tenant user.

emailstring · min: 1Required

User email address.

namestring · nullableOptional

Display name.

rolestring · min: 1Required

Tenant role to assign.

Responses

201

User created or attached.

text/plainapplication/jsontext/json

409

User already has access to tenant.

text/plainapplication/jsontext/json

post

/api/{tenantId}/admin/users

HTTPcURLJavaScriptPython

POST /api/{tenantId}/admin/users HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "email": "text",
  "name": null,
  "role": "text"
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "email": "text",
  "name": null,
  "blocked": true,
  "lastLogin": null,
  "tenantRole": null
}

Get a user attached to the tenant

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/admin/users/{userId}

Returns the back-office user details for the requested tenant.

Authorization

Requires tenant.access:read scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

userIdstringRequired

tenantIdstringRequired

Responses

200

User returned.

text/plainapplication/jsontext/json

Tenant-scoped user representation.

idstring · min: 1Required

User identifier.

emailstring · min: 1Required

User email address.

namestring · nullableOptional

Display name.

blockedbooleanOptional

True when the account is blocked.

lastLoginstring · nullableOptional

Last login timestamp.

tenantRolestring · nullableOptional

Tenant role assigned to the user.

404

User not found for tenant.

text/plainapplication/jsontext/json

get

/api/{tenantId}/admin/users/{userId}

HTTPcURLJavaScriptPython

GET /api/{tenantId}/admin/users/{userId} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "text",
  "email": "text",
  "name": null,
  "blocked": true,
  "lastLogin": null,
  "tenantRole": null
}

Update a user attached to the tenant

put

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/admin/users/{userId}

Updates the tenant role and/or display name for a back-office user.

Authorization

Requires tenant.access:write scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

userIdstringRequired

tenantIdstringRequired

Body

application/jsontext/jsonapplication/*+json

Request payload for updating a tenant user.

namestring · nullableOptional

Updated display name.

rolestring · nullableRequired

Updated tenant role.

Responses

200

User updated.

text/plainapplication/jsontext/json

Tenant-scoped user representation.

idstring · min: 1Required

User identifier.

emailstring · min: 1Required

User email address.

namestring · nullableOptional

Display name.

blockedbooleanOptional

True when the account is blocked.

lastLoginstring · nullableOptional

Last login timestamp.

tenantRolestring · nullableOptional

Tenant role assigned to the user.

404

User not found for tenant.

text/plainapplication/jsontext/json

put

/api/{tenantId}/admin/users/{userId}

HTTPcURLJavaScriptPython

PUT /api/{tenantId}/admin/users/{userId} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "name": null,
  "role": null
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "email": "text",
  "name": null,
  "blocked": true,
  "lastLogin": null,
  "tenantRole": null
}

Remove a user from the tenant

delete

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/admin/users/{userId}

Removes the tenant access from the user but keeps the Auth0 account.

Authorization

Requires tenant.access:write scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

userIdstringRequired

tenantIdstringRequired

Responses

204

User removed from tenant.

delete

/api/{tenantId}/admin/users/{userId}

HTTPcURLJavaScriptPython

DELETE /api/{tenantId}/admin/users/{userId} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

204

User removed from tenant.

No content