Organization Users

Endpointhttps://app.monad.com/api

Download schema

Organization user management

List organization users

GET

https://app.monad.com/api

/v1/{organization_id}/users

Authorization (header)

x-api-key (header)

List organization users

List organization users › path Parameters

organization_id

string · required

Organization ID

List organization users › query Parameters

limit

integer

Limit

offset

integer

Offset

List organization users › Responses

List of organization users

object

object[]

GET/v1/{organization_id}/users

curl --request GET \
  --url https://app.monad.com/api/v1/:organization_id/users

shell

Example Responses

{
  "pagination": {
    "limit": 0,
    "offset": 0,
    "total": 0
  },
  "users": [
    {
      "auth_provider": {
        "connection_id": "connection_id",
        "created_at": "created_at",
        "id": "id",
        "provider": "provider",
        "provider_id": "provider_id",
        "user_id": "user_id"
      },
      "connection_id": "connection_id",
      "created_at": "created_at",
      "email": "email",
      "id": "id",
      "inherited": true,
      "role_id": "role_id",
      "role_name": "role_name",
      "source_organization_id": "source_organization_id",
      "source_organization_name": "source_organization_name",
      "updated_at": "updated_at",
      "username": "username"
    }
  ]
}

json

application/json

Add user to organization

POST

https://app.monad.com/api

/v1/{organization_id}/users

Authorization (header)

x-api-key (header)

Add user to organization

Add user to organization › path Parameters

organization_id

string · required

organization ID

Add user to organization › Request Body

Request body for adding a user to an organization

role_id

string · required

user_id

string · required

Add user to organization › Responses

Response body for adding a user to an organization

object

connection_id

string

created_at

string

email

string

id

string

inherited

boolean

role_id

string

role_name

string

source_organization_id

string

source_organization_name

string

updated_at

string

username

string

POST/v1/{organization_id}/users

curl --request POST \
  --url https://app.monad.com/api/v1/:organization_id/users \
  --header 'Content-Type: application/json' \
  --data '
{
  "role_id": "role_id",
  "user_id": "user_id"
}
'

shell

Example Request Body

{
  "role_id": "role_id",
  "user_id": "user_id"
}

json

Example Responses

{
  "auth_provider": {
    "connection_id": "connection_id",
    "created_at": "created_at",
    "id": "id",
    "provider": "provider",
    "provider_id": "provider_id",
    "user_id": "user_id"
  },
  "connection_id": "connection_id",
  "created_at": "created_at",
  "email": "email",
  "id": "id",
  "inherited": true,
  "role_id": "role_id",
  "role_name": "role_name",
  "source_organization_id": "source_organization_id",
  "source_organization_name": "source_organization_name",
  "updated_at": "updated_at",
  "username": "username"
}

json

application/json

Leave organization

POST

https://app.monad.com/api

/v1/{organization_id}/users/leave

Authorization (header)

Leave organization (self-service removal)

Leave organization › path Parameters

organization_id

string · required

Organization ID

Leave organization › Responses

Remove user from organization

DELETE

https://app.monad.com/api

/v1/{organization_id}/users/{user_id}

Authorization (header)

x-api-key (header)

Remove user from organization

Remove user from organization › path Parameters

organization_id

string · required

Organization ID

user_id

string · required

User ID

Remove user from organization › query Parameters

user_auth_provider_id

string · required

User Auth Provider ID

Remove user from organization › Responses

Update user in organization

PATCH

https://app.monad.com/api

/v1/{organization_id}/users/{user_id}

Authorization (header)

x-api-key (header)

Update user in organization

Update user in organization › path Parameters

organization_id

string · required

Organization ID

user_id

string · required

User ID

Update user in organization › Request Body

Request body for updating a user in an organization

role_id

string

user_auth_provider_id

string

Update user in organization › Responses

Response body for updating a user in an organization

object

connection_id

string

created_at

string

email

string

id

string

inherited

boolean

role_id

string

role_name

string

source_organization_id

string

source_organization_name

string

updated_at

string

username

string

PATCH/v1/{organization_id}/users/{user_id}

curl --request PATCH \
  --url https://app.monad.com/api/v1/:organization_id/users/:user_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "role_id": "role_id",
  "user_auth_provider_id": "user_auth_provider_id"
}
'

shell

Example Request Body

{
  "role_id": "role_id",
  "user_auth_provider_id": "user_auth_provider_id"
}

json

Example Responses

{
  "auth_provider": {
    "connection_id": "connection_id",
    "created_at": "created_at",
    "id": "id",
    "provider": "provider",
    "provider_id": "provider_id",
    "user_id": "user_id"
  },
  "connection_id": "connection_id",
  "created_at": "created_at",
  "email": "email",
  "id": "id",
  "inherited": true,
  "role_id": "role_id",
  "role_name": "role_name",
  "source_organization_id": "source_organization_id",
  "source_organization_name": "source_organization_name",
  "updated_at": "updated_at",
  "username": "username"
}

json

application/json

Organizations Organization Invites

List organization users

GET

https://app.monad.com/api

/v1/{organization_id}/users

Authorization (header)

x-api-key (header)

List organization users

List organization users › path Parameters

organization_id

string · required

Organization ID

List organization users › query Parameters

limit

integer

Limit

offset

integer

Offset

List organization users › Responses

List of organization users

object

object[]

Add user to organization

POST

https://app.monad.com/api

/v1/{organization_id}/users

Authorization (header)

x-api-key (header)

Add user to organization

Add user to organization › path Parameters

organization_id

string · required

organization ID

Add user to organization › Request Body

Request body for adding a user to an organization

role_id

string · required

user_id

string · required

Add user to organization › Responses

Response body for adding a user to an organization

object

connection_id

string

created_at

string

email

string

id

string

inherited

boolean

role_id

string

role_name

string

source_organization_id

string

source_organization_name

string

updated_at

string

username

string

Remove user from organization

DELETE

https://app.monad.com/api

/v1/{organization_id}/users/{user_id}

Authorization (header)

x-api-key (header)

Remove user from organization

Remove user from organization › path Parameters

organization_id

string · required

Organization ID

user_id

string · required

User ID

Remove user from organization › query Parameters

user_auth_provider_id

string · required

User Auth Provider ID

Remove user from organization › Responses

Update user in organization

PATCH

https://app.monad.com/api

/v1/{organization_id}/users/{user_id}

Authorization (header)

x-api-key (header)

Update user in organization

Update user in organization › path Parameters

organization_id

string · required

Organization ID

user_id

string · required

User ID

Update user in organization › Request Body

Request body for updating a user in an organization

role_id

string

user_auth_provider_id

string

Update user in organization › Responses

Response body for updating a user in an organization

object

connection_id

string

created_at

string

email

string

id

string

inherited

boolean

role_id

string

role_name

string

source_organization_id

string

source_organization_name

string

updated_at

string

username

string