MeiroDocs
APIMeiro Integrations API

Users

+ Parameters

Section: Group Users. Base URL: https://api.instance_name.meiro.io/.

Users [/users{?limit,offset,order_by,order_dir}]

List All Users [GET]

  • Parameters

    • limit (number, optional) - Limit of the number of records returned
    • offset (number, optional) - Offset for the number of records returned
    • order_by (string, optional) - Ordered column name
    • order_dir (string, optional) - Ordering direction

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "users": [
        {
            "id": 100,
            "name": "John Doe",
            "email": "john@doe.foo",
            "role": "user",
            "disabled": 0,
            "deleted": 0,
            "can_create_workspaces": 1,
            "can_create_dawgs": 1,
            "last_login": "2017-01-01 16:00:00",
            "sso_enabled": 0,
            "created": "2017-01-01 15:35:00"
        }
    ],
    "selection_settings": {
        "limit": 20,
        "offset": null,
        "order_by": "id",
        "order_dir": "ASC"
    }
}

Create a User [POST]

  • Attributes

    • name: Mr. Doe (string)
    • email: example@email.com (string)
    • password: my-password (string)
    • role: admin (string) - user|admin
    • disabled: 0 (number, optional)
    • deleted: 0 (number, optional)
    • can_create_workspaces: 1 (number, optional)
    • sso_enabled: 1 (number, optional)
    • load_full_structure (number, optional) - Full data structure return flag
    • workspaces_acl: {200: "write"} (string) - optional (json)

  • Request (application/json)

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 201 (application/json)

{
    "user": {
        "id": "100",
        "name": "Mr. Doe",
        "email": "example@email.com",
        "role": "admin",
        "disabled": 0,
        "deleted": 0,
        "can_create_workspaces": 1,
        "can_create_dawgs": 1,
        "last_login": null,
        "sso_enabled": 0,
        "created": "2017-01-01 15:00:00"
    }
}

Create Or Restore a User [/users/create_or_restore]

Create Or Restore a User [POST]

  • Attributes

    • name: Mr. Doe (string)
    • email: example@email.com (string)
    • password: my-password (string)
    • role: admin (string) - user|admin
    • disabled: 0 (number, optional)
    • deleted: 0 (number, optional)
    • can_create_workspaces: 1 (number, optional)
    • sso_enabled: 1 (number, optional)
    • load_full_structure (number, optional) - Full data structure return flag
    • workspaces_acl: {200: "write"} (string) - optional (json)

  • Request (application/json)

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 201 (application/json)

{
    "user": {
        "id": "100",
        "name": "Mr. Doe",
        "email": "example@email.com",
        "role": "admin",
        "disabled": 0,
        "deleted": 0,
        "can_create_workspaces": 1,
        "can_create_dawgs": 1,
        "last_login": null,
        "sso_enabled": 1,
        "created": "2017-01-01 15:00:00"
    }
}

Users' actions history list [/users/history_actions{?limit,offset,load_full_structure}]

Retrieve a Users' Actions History List [GET]

  • Parameters

    • limit (number, optional) - Limit of the number of records returned
    • offset (number, optional) - Offset for the number of records returned
    • load_full_structure (number, optional) - Full data structure return flag

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "users_history_actions": [
        {
            "type": "workspaces_history",
            "entity": {}
            "action_type": "edit",
            "history_id": null,
            "datetime": "2017-11-19 23:40:18"
        },
        {
            "type": "workspaces_history",
            "entity": {}
            "action_type": "create",
            "history_id": 273,
            "datetime": "2017-11-19 23:05:18"
        }
    ],
    "selection_settings": {
        "limit": 20,
        "offset": null
    }
}

User [/users/{user_id}]

Retrieve a User [GET]

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
   "user": {
        "id": "100",
        "name": "Mr. Doe",
        "email": "example@email.com",
        "role": "user",
        "disabled": 0,
        "deleted": 0,
        "can_create_workspaces": 1,
        "can_create_dawgs": 1,
        "last_login": "2017-01-01 16:00:00",
        "sso_enabled": 0,
        "created": "2017-01-01 15:00:00"
    }
}

Modify a User [PATCH]

  • Attributes

    • email: example@email.com (string) - optional
    • password: my-password (string) - optional
    • name: Mr. Doe (string) - optional
    • role: admin (string) - user|admin
    • disabled: 0 (number, optional)
    • deleted: 0 (number, optional)
    • can_create_workspaces: 1 (number, optional)
    • can_create_dawgs: 1 (number, optional)
    • load_full_structure (number, optional) - Full data structure return flag

  • Request (application/json)

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "user": {
        "id": "100",
        "name": "Mr. Doe",
        "email": "example@email.com",
        "role": "admin",
        "disabled": 0,
        "deleted": 0,
        "can_create_workspaces": 1,
        "can_create_dawgs": 1,
        "last_login": "2017-01-01 16:00:00",
        "sso_enabled": 0,
        "created": "2017-01-01 15:00:00"
    }
}

Delete a User [DELETE /users/{user_id}{?remove_authorship}]

  • Parameters

    • remove_authorship (number, optional) - when set to 1, user's authorship will be removed from all workspaces and dawgs

  • Request (application/json)

  • Response 200 (application/json)

{
    "message": "OK"
}

User's history list [/users/{user_id}/history{?limit,offset,order_by,order_dir}]

Retrieve a User's History List [GET]

  • Parameters

    • limit (number, optional) - Limit of the number of records returned
    • offset (number, optional) - Offset for the number of records returned
    • order_by (string, optional) - Ordered column name
    • order_dir (string, optional) - Ordering direction

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "history_list": [
        {
            "id": null,
            "user": {
                "id": 200,
                "name": "Mr. Foo",
                "email": "example@email.com",
                "created": "2017-01-01 15:00:00"
            },
            "previous_history": {
                "id": 100,
                "user": {
                    "id": 200,
                    "name": "Mr. Doe",
                    "email": "example@email.com",
                    "created": "2017-01-01 11:00:00"
                }
            }
        },
        {
            "id": 100,
            "user": {
                "id": 200,
                "name": "Mr. Doe",
                "email": "example@email.com",
                "created": "2017-01-01 11:00:00"
            }
        }
    ],
    "selection_settings": {
        "limit": 20,
        "offset": null,
        "order_by": "id",
        "order_dir": "ASC"
    }
}

User's history item [/users/{user_id}/history/{history_id}]

Retrieve a User's History Item [GET]

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "history": {
        "id": 100,
        "user": {
            "id": 200,
            "name": "Mr. Doe",
            "email": "example@email.com",
            "created": "2017-01-01 15:00:00"
        },
        "previous_history": {
            "id": 200,
            "user": {
                "id": 200,
                "name": "Mr. Doe",
                "email": "example@email.com",
                "created": "2017-01-01 11:00:00"
            }
        }
    }
}

User's actions history list [/users/{user_id}/history_actions{?limit,offset,load_full_structure}]

Retrieve a User's Actions History List [GET]

  • Parameters

    • limit (number, optional) - Limit of the number of records returned
    • offset (number, optional) - Offset for the number of records returned
    • load_full_structure (number, optional) - Full data structure return flag

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "user_history_actions": [
        {
            "type": "workspaces_history",
            "entity": {}
            "action_type": "edit",
            "history_id": null,
            "datetime": "2017-11-19 23:40:18"
        },
        {
            "type": "workspaces_history",
            "entity": {}
            "action_type": "create",
            "history_id": 273,
            "datetime": "2017-11-19 23:05:18"
        }
    ],
    "selection_settings": {
        "limit": 20,
        "offset": null
    }
}

Trashed users [/users/trash{?limit,offset,order_by,order_dir}]

List All Trashed Users [GET]

  • Parameters

    • limit (number, optional) - Limit of the number of records returned
    • offset (number, optional) - Offset for the number of records returned
    • order_by (string, optional) - Ordered column name
    • order_dir (string, optional) - Ordering direction

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "trashed_users": [
        {
            "id": 100,
            "name": "John Doe",
            "email": "john@doe.foo",
            "disabled": 0,
            "deleted": 1,
            "created": "2017-01-01 15:35:00"
        }
    ],
    "selection_settings": {
        "limit": 20,
        "offset": null,
        "order_by": "id",
        "order_dir": "ASC"
    }
}

Trashed User [/users/trash/{user_id}]

Restore a Trashed User [PATCH]

  • Request (application/json)

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "user": {
        "id": "100",
        "name": "Mr. Doe",
        "email": "example@email.com",
        "disabled": 0,
        "deleted": 0,
        "created": "2017-01-01 15:00:00"
    }
}

User invitation [/users/invitation]

Send user invitation [POST]

  • Attributes

    • name: Mr. Doe (string)
    • email: john@doe.foo (string)
    • role: user (string) - optional
    • workspaces_acl: {200: "write"} (string) - optional (json)

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 201 (application/json)

{
    "user": {
        "id": 100,
        "name": "Mr. Doe",
        "email": "john@doe.foo",
        "role": "user",
        "disabled": 0,
        "deleted": 0,
        "last_login": null,
        "sso_enabled": 0,
        "created": "2017-01-01 15:35:00"
    }
}

Re-send user invitation [PATCH]

  • Attributes

    • email: john@doe.foo (string)

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "user": {
        "id": 100,
        "name": "Mr. Doe",
        "email": "john@doe.foo",
        "role": "user",
        "disabled": 0,
        "deleted": 0,
        "last_login": null,
        "sso_enabled": 0,
        "created": "2017-01-01 15:35:00"
    }
}

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "user_invitation_link": "INVITATION_LINK_URL"
}

User's password reset [/users/password_reset]

Request user's password reset [POST]

  • Attributes

    • email: example@email.com (string)

  • Request (application/json)

  • Response 200 (application/json)

{
    "message": "OK"
}

Reset user's password [PATCH]

  • Attributes

    • email: example@email.com (string)
    • password: my-password (string)
    • password_reset_token: 1234567890abcdef (string)

  • Request (application/json)

  • Response 200 (application/json)

{
    "message": "OK"
}

Users' ACL report [/users/acl-report]

Retrieve users' ACL report [GET]

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "acl_reports": [
        {
            "id": 100,
            "name": "Mr. Doe",
            "email": "john@doe.foo",
            "role": "user",
            "disabled": 0,
            "deleted": 0,
            "owned_dawgs": [
                {
                    "id": 1,
                    "name": "test dawg",
                    "deleted": 0,
                    "disabled": 0,
                }
            ],
            "owned_workspaces": [
                {
                    "id": 2,
                    "name": "test workspace",
                    "deleted": 0,
                    "disabled": 0,
                }
            ],
            "dawgs_permissions": [
                {
                    "id": 3,
                    "name": "test dawg 2",
                    "permission": "read",
                    "deleted": 0,
                    "disabled": 0,
                }
            ],
            "workspaces_permissions": [
                {
                    "id": 4,
                    "name": "test workspace 2",
                    "permission": "read",
                    "deleted": 0,
                    "disabled": 0,
                }
            ]
        }
    ]
}

Identity

+ Request

Dawgs

+ Parameters

On this page

Users [/users{?limit,offset,order_by,order_dir}]List All Users [GET]Create a User [POST]Create Or Restore a User [/users/create_or_restore]Create Or Restore a User [POST]Users' actions history list [/users/history_actions{?limit,offset,load_full_structure}]Retrieve a Users' Actions History List [GET]User [/users/{user_id}]Retrieve a User [GET]Modify a User [PATCH]Delete a User [DELETE /users/{user_id}{?remove_authorship}]User's history list [/users/{user_id}/history{?limit,offset,order_by,order_dir}]Retrieve a User's History List [GET]User's history item [/users/{user_id}/history/{history_id}]Retrieve a User's History Item [GET]User's actions history list [/users/{user_id}/history_actions{?limit,offset,load_full_structure}]Retrieve a User's Actions History List [GET]Trashed users [/users/trash{?limit,offset,order_by,order_dir}]List All Trashed Users [GET]Trashed User [/users/trash/{user_id}]Restore a Trashed User [PATCH]User invitation [/users/invitation]Send user invitation [POST]Re-send user invitation [PATCH]User invitation link [/users/{user_id}/invitation_link]Retrieve user's invitation link [GET]User's password reset [/users/password_reset]Request user's password reset [POST]Reset user's password [PATCH]Users' ACL report [/users/acl-report]Retrieve users' ACL report [GET]