3DM Publisher Admin API - User Management

Back to the index

This page describes the user management API's for 3DM Publisher.
Please familiarize yourself with the basics first before continuing.

A User models a well-known user of the server.

Properties:

A Usergroup is a list of users.

Properties:

This operation retrieves all users.

GET /api/3/user

[
    {
        "id": 28,
        "username": "test",
        "email": "test@company.com",
        "first_name": "Test",
        "last_name": "User",
        "password": "test123",
        "description": "Test user"
        "language": "english",
        "preferences": "{}",
        "description": "Supportl",
        "passwordLastModified": 1651217754682
    },
    ...
]

This operation creates a new user account.
The password can be provided in plain text using the password field.

Fields: Model: User

POST /api/3/user

{
    "username": "test",
    "email": "test@company.com",
    "first_name": "Test",
    "last_name": "User",
    "password": "test123",
    "passwordForceChange": true,
    "description": "Test user"
}

{
    "id": 28,
    "email": "test@company.com",
    "username": "test",
    "first_name": "Test",
    "last_name": "User",
    "language": "english",
    "preferences": "{}",
    "password": "ecd71870d1963316a97e3ac3408c9835ad8cf0f3c1bc703527c30265534f75ae",
    "description": "Test user",
    "passwordForceChange": true,
    "passwordLastModified": 1753874442231
}

{
    "code": "field_not_unique",
    "message": "Uniqueness check failed: Another item with this name value 'test' already exists.",
}

The following fields can be updated:

• username
• email
• first_name
• last_name
• description
• password
• passwordForceChange

Fields: see Model: User

POST /api/3/user/123

{
    "first_name": "John"
}

No content

This operation deletes an existing user account.

• Usergroup memberships of the user are removed.
• Publication permissions for the user are removed.
• Publication user bookmarks for the user are removed.

DELETE /api/3/user/123

No content

{
    "code": "not_found",
    "message": "Delete failed: An item with this id does not exist."
}

This operation retrieves all usergroups.

• Users in each group are also returned, but only with the id field filled in.

GET /api/3/usergroup

[
    {
        "id": 4,
        "name": "TestGroup",
        "description": "description",
        "type": "team",
        "user": [
            {
                "id": 20
            }
        ]
    },
    ...
]

This operation creates a new usergroup.

Fields: Model: User Group Fields: Model: User

POST /api/3/usergroup

{
    "name": "TestGroup",
    "description": "description",
    "type": "team",
    "user": [
        {
            "id": 20
        }
    ]
}

{
    "id": 4,
    "name": "TestGroup",
    "description": "description",
    "type": "team",
    "user": [
        {
            "id": 20
        }
    ]
}

{
    "code": "field_not_unique",
    "message": "Uniqueness check failed: Another item with this name value 'TestGroup' already exists.",
}

The following fields can be updated:

• name
• description
• user

Fields: Model: Usergroup
Fields: Model: User

POST /api/3/usergroup/123

{
    "name": "Users2",
    "user": [
        {
            "id": 22
        }
    ]
}

No content

This operation deletes an existing usergroup.

• Only the usergroup is deleted, not the users in it.
• Publication permissions for the usergroup are removed.

DELETE /api/3/usergroup/123

No content

{
    "code": "not_found",
    "message": "Delete failed: An item with this id does not exist."
}