Instance Users

Endpoints for managing users in Evo instances

List instance users (deprecated - use /users endpoint)

Workspaces API

Returns a paginated list of all users with access to the Evo instance. Users with multiple roles will only have their most privileged role returned.

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Parameters

authorizationstring

Required

org_iduuid

Required

Default: 20

The maximum number of results to return.

The (zero-based) offset of the first item returned in the collection.

Returns

200

Successful Response

countinteger

firsturi

(1, 2,083) chars

nexturi | null

(1, 2,083) chars

previousuri | null

(1, 2,083) chars

emailstring

full_namestring

iduuid

descriptionstring

iduuid

namestring

Endpoint

GET

/workspace/orgs/{org_id}/members

Request

curl -X GET 'https://{service_host}/workspace/orgs/{org_id}/members' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

{
  "links": {
    "count": 0,
    "first": "https://example.com",
    "next": "https://example.com",
    "previous": "https://example.com"
  },
  "results": [
    {
      "email": "string",
      "full_name": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "roles": [
        {
          "description": "string",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        }
      ]
    }
  ]
}

Add user to instance (deprecated - use /users endpoint)

Workspaces API

Version: 1.0

Add user to the Evo instance

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Parameters

authorizationstring

Required

org_iduuid

Required

emailstring

rolesstring[]

{
  "users": [
    {
      "email": "string",
      "roles": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ]
    }
  ]
}

Returns

201

Successful Response

created_datedate-time

emailstring

expiration_datedate-time

iduuid

invited_by_emailstring

descriptionstring

iduuid

namestring

statusstring

emailstring

full_namestring

iduuid

descriptionstring

iduuid

namestring

Endpoint

POST

/workspace/orgs/{org_id}/members

Request

curl -X POST 'https://{service_host}/workspace/orgs/{org_id}/members' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

{
  "invitations": [
    {
      "created_date": "2024-07-29T15:51:28.071Z",
      "email": "string",
      "expiration_date": "2024-07-29T15:51:28.071Z",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "invited_by_email": "string",
      "roles": [
        {
          "description": "string",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        }
      ],
      "status": "string"
    }
  ],
  "members": [
    {
      "email": "string",
      "full_name": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "roles": [
        {
          "description": "string",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        }
      ]
    }
  ]
}

List instance user invitations

Workspaces API

Version: 1.0

Returns a paginated list of all user invitations for the Evo instance

Parameters

authorizationstring

Required

org_iduuid

Required

Default: 20

The maximum number of results to return.

The (zero-based) offset of the first item returned in the collection.

Returns

200

Successful Response

countinteger

firsturi

(1, 2,083) chars

nexturi | null

(1, 2,083) chars

previousuri | null

(1, 2,083) chars

created_datedate-time

emailstring

expiration_datedate-time

iduuid

invited_by_emailstring

descriptionstring

iduuid

namestring

statusstring

Endpoint

GET

/workspace/orgs/{org_id}/members/invitations

Request

curl -X GET 'https://{service_host}/workspace/orgs/{org_id}/members/invitations' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

{
  "links": {
    "count": 0,
    "first": "https://example.com",
    "next": "https://example.com",
    "previous": "https://example.com"
  },
  "results": [
    {
      "created_date": "2024-07-29T15:51:28.071Z",
      "email": "string",
      "expiration_date": "2024-07-29T15:51:28.071Z",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "invited_by_email": "string",
      "roles": [
        {
          "description": "string",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        }
      ],
      "status": "string"
    }
  ]
}

Delete instance user invitation

Workspaces API

Version: 1.0

Deletes a user invitation for the Evo instance

Parameters

authorizationstring

Required

org_iduuid

Required

invitation_iduuid

Required

Returns

204

Successful Response

Endpoint

DELETE

/workspace/orgs/{org_id}/members/invitations/{invitation_id}

Request

curl -X DELETE 'https://{service_host}/workspace/orgs/{org_id}/members/invitations/{invitation_id}' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

No response body.

List instance user roles

Workspaces API

Version: 1.0

List all roles in the Evo instance

Parameters

authorizationstring

Required

org_iduuid

Required

Returns

200

Successful Response

descriptionstring

iduuid

namestring

permissionsstring[]

Endpoint

GET

/workspace/orgs/{org_id}/members/roles

Request

curl -X GET 'https://{service_host}/workspace/orgs/{org_id}/members/roles' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

{
  "roles": [
    {
      "description": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "permissions": [
        "string"
      ]
    }
  ]
}

List instance users

Workspaces API

Version: 1.0

Returns a paginated list of all users with access to the Evo instance. Users with multiple roles will only have their most privileged role returned.

Parameters

authorizationstring

Required

org_iduuid

Required

Default: 20

The maximum number of results to return.

The (zero-based) offset of the first item returned in the collection.

Returns

200

Successful Response

countinteger

firsturi

(1, 2,083) chars

nexturi | null

(1, 2,083) chars

previousuri | null

(1, 2,083) chars

emailstring

full_namestring

iduuid

descriptionstring

iduuid

namestring

Endpoint

GET

/workspace/orgs/{org_id}/members/users

Request

curl -X GET 'https://{service_host}/workspace/orgs/{org_id}/members/users' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

{
  "links": {
    "count": 0,
    "first": "https://example.com",
    "next": "https://example.com",
    "previous": "https://example.com"
  },
  "results": [
    {
      "email": "string",
      "full_name": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "roles": [
        {
          "description": "string",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        }
      ]
    }
  ]
}

Add user to instance

Workspaces API

Version: 1.0

Add user to the Evo instance

Parameters

authorizationstring

Required

org_iduuid

Required

emailstring

rolesstring[]

{
  "users": [
    {
      "email": "string",
      "roles": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ]
    }
  ]
}

Returns

201

Successful Response

created_datedate-time

emailstring

expiration_datedate-time

iduuid

invited_by_emailstring

descriptionstring

iduuid

namestring

statusstring

emailstring

full_namestring

iduuid

descriptionstring

iduuid

namestring

Endpoint

POST

/workspace/orgs/{org_id}/members/users

Request

curl -X POST 'https://{service_host}/workspace/orgs/{org_id}/members/users' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

{
  "invitations": [
    {
      "created_date": "2024-07-29T15:51:28.071Z",
      "email": "string",
      "expiration_date": "2024-07-29T15:51:28.071Z",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "invited_by_email": "string",
      "roles": [
        {
          "description": "string",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        }
      ],
      "status": "string"
    }
  ],
  "members": [
    {
      "email": "string",
      "full_name": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "roles": [
        {
          "description": "string",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        }
      ]
    }
  ]
}

Remove instance user

Workspaces API

Version: 1.0

Remove a user from the Evo instance

Parameters

authorizationstring

Required

org_iduuid

Required

user_iduuid

Required

Returns

204

Successful Response

Endpoint

DELETE

/workspace/orgs/{org_id}/members/users/{user_id}

Request

curl -X DELETE 'https://{service_host}/workspace/orgs/{org_id}/members/users/{user_id}' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

No response body.

Update instance user roles

Workspaces API

Version: 1.0

Update the roles of a user in the Evo instance

Parameters

authorizationstring

Required

org_iduuid

Required

user_iduuid

Required

rolesstring[]

Required

{
  "roles": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}

Returns

200

Successful Response

iduuid

descriptionstring

iduuid

namestring

Endpoint

PATCH

/workspace/orgs/{org_id}/members/users/{user_id}

Request

curl -X PATCH 'https://{service_host}/workspace/orgs/{org_id}/members/users/{user_id}' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "roles": [
    {
      "description": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string"
    }
  ]
}

Remove instance user (deprecated - use /users endpoint)

Workspaces API

Version: 1.0

Remove a user from the Evo instance

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Parameters

authorizationstring

Required

org_iduuid

Required

user_iduuid

Required

Returns

204

Successful Response

Endpoint

DELETE

/workspace/orgs/{org_id}/members/{user_id}

Request

curl -X DELETE 'https://{service_host}/workspace/orgs/{org_id}/members/{user_id}' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

No response body.

Update instance user roles (deprecated - use /users endpoint)

Workspaces API

Version: 1.0

Update the roles of a user in the Evo instance

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Parameters

authorizationstring

Required

org_iduuid

Required

user_iduuid

Required

rolesstring[]

Required

{
  "roles": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}

Returns

200

Successful Response

iduuid

descriptionstring

iduuid

namestring

Endpoint

PATCH

/workspace/orgs/{org_id}/members/{user_id}

Request

curl -X PATCH 'https://{service_host}/workspace/orgs/{org_id}/members/{user_id}' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "roles": [
    {
      "description": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string"
    }
  ]
}

List instance users (deprecated - use /users endpoint)​

Parameters

Request headers

Request headers

Path parameters

Path parameters

Query parameters

Query parameters

limitinteger

offsetinteger

Returns

200

Schema

linksPaginationLinksWithoutTotal

resultsBaseInstanceUserWithRolesResponse[]

rolesBaseInstanceUserRoleResponse[]

Endpoint

Request

Response

Add user to instance (deprecated - use /users endpoint)​

Parameters

Request headers

Request headers

Path parameters

Path parameters

Body parameters Required

Body parameters Required

usersUserRoleMapping[]Required

Example body

Example body

Returns

201

Schema

invitationsBaseInstanceUserInvitationWithRolesResponse[]

rolesBaseInstanceUserRoleResponse[]

membersBaseInstanceUserWithRolesResponse[]

rolesBaseInstanceUserRoleResponse[]

Endpoint

Request

Response

List instance user invitations​

Parameters

Request headers

Request headers

Path parameters

Path parameters

Query parameters

Query parameters

limitinteger

offsetinteger

Returns

200

Schema

linksPaginationLinksWithoutTotal

resultsBaseInstanceUserInvitationWithRolesResponse[]

rolesBaseInstanceUserRoleResponse[]

Endpoint

Request

Response

Delete instance user invitation​

Parameters

Request headers

Request headers

Path parameters

Path parameters

Returns

204

Endpoint

Request

Response

List instance user roles​

Parameters

Request headers

Request headers

Path parameters

Path parameters

Returns

200

Schema

rolesInstanceRoleWithPermissions[]

List instance users (deprecated - use /users endpoint)

Add user to instance (deprecated - use /users endpoint)

Body parameters
Required

List instance user invitations

Delete instance user invitation

List instance user roles

List instance users

Add user to instance

Body parameters
Required

Remove instance user

Update instance user roles

Body parameters
Required