Skip to main content
API docs by Redocly

org-user-management (1.0)

Download OpenAPI specification:Download

Administers organizations and users.

See our getting started guide for more detailed information on how to use our APIs.

Organization

An organization represents your company within the Model-Prime platform.

Returns details about your organization.

Responses

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "short_name": "string",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Users

Users are members of your organization with authenticated access to the Model-Prime platform.

Returns your user details.

Returns your user details.

Responses

Response samples

Content type
application/json
{
  • "email": "string",
  • "id": "string",
  • "name": "string",
  • "roles": [
    ]
}

Updates your user details across all organizations.

Updates your user details across all organizations. The request is only valid for a user authenticating with a username-password connection to log into Model-Prime. Users authenticating with third-party connections such as google-oauth2 will need to update their details through the provider.

Request Body schema: application/json
required

The updated user data. Any omitted fields will be left unchanged.

email
string
name
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "email": "string",
  • "id": "string",
  • "name": "string"
}

Lists users in your organization.

query Parameters
page_number
integer >= 1
Default: 1

The desired page number, starting from 1. For instance, if page_size=100, then page_number=2 will contain items 101-200.

page_size
integer [ 0 .. 100 ]
Default: 100

The number of items to return per page. The maximum value is 100. If the value is greater than 100, then 100 will be used.

name_search
string >= 3 characters ^[a-zA-Z ]{3,}$

A case-insensitive search string for filtering users by name.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ]
}

Deletes the specified user from your organization.

path Parameters
id
string

The unique id of the resource

Responses

Returns the details for the specified user.

Returns the details for the specified user, including the user's roles.

path Parameters
id
string

The unique id of the resource

Responses

Response samples

Content type
application/json
{
  • "email": "string",
  • "id": "string",
  • "name": "string",
  • "roles": [
    ]
}

Requests an Auth0 password reset for the specified user.

Requests an Auth0 password reset for the specified user and sends a reset email to the user. The request is only valid for a user authenticating with a username-password connection to log into Model-Prime. Users authenticating with third-party connections such as google-oauth2 will need to reset credentials through the provider.

path Parameters
id
string

The unique id of the resource

Responses

Creates a new role set for the specified user, replacing their existing roles.

path Parameters
id
string

The unique id of the resource

Request Body schema: application/json
required
Array
string (PermissionRole)
Enum: "admin" "developer" "analyst"

Responses

Request samples

Content type
application/json
[
  • "admin"
]

Invites a user to your organization

Invites a user to your organization via an email with actions to complete registration. The user will be created with the specified roles after they complete the registration process.

Request Body schema: application/json
required

Specifies the email of the user and the list of roles to be assigned.

connection
required
string or null (ConnectionType)
Default: "google-oauth2"
Value: "google-oauth2"

The type of connection used to log into the Model-Prime platform such as google-oauth2. If no connection is provided, the user will be required to create an account with a username and password.

email
required
string
name
required
string
roles
required
Array of strings (PermissionRole)
Items Enum: "admin" "developer" "analyst"

Responses

Request samples

Content type
application/json
{
  • "connection": "google-oauth2",
  • "email": "string",
  • "name": "string",
  • "roles": [
    ]
}