IAM

User management

Reference

Find users

Find users by default only returns an array of object with the least possible data (id, surname, firstname, an optional image and some important settings) for privacy reasons. If you want a detailed list, the requesting user must have IAM permission “user.extendedList” and you have to send the parameter “extended” as true in your request payload.

/v5/user

{
    "body": [
        {
            "id": 123,
            "firstname": "Jane",
            "lastname": "Doe",
            "email": "jane@admiralcloud.com",
            "country": "LA",
            "uiLanguage": "en"
        }
    ]
}

/v5/user

{
    "body": [
        {
            "id": 123,
            "firstname": "Jane",
            "lastname": "Doe",
            "email": "jane@admiralcloud.com",
            "passwordChanged": 1595764541,
            "country": "DE",
            "uiLanguage": "de",
            "timezone": "Europe\/Berlin",
            "mfakey": false,
            "individualConfiguration": {
                "useBeta": false
            },
            "searchConfiguration": [],
            "image": null,
            "welcomeMessage": "Hey",
            "welcomeBackground": -2,
            "settings": {
                "releaseMediaContainer": false,
                "forceDeleteMediaContainer": true,
                "developerAccount": {
                    "enabled": true
                }
            },
            "lastLoginAt": 1595757588,
            "lastInviteAt": 1595138302,
            "deletedAt": 0,
            "deactivatedAt": 0,
            "flag": 0,
            "adminLevel": 1,
            "lastEditorId": 1,
            "creatorId": 121,
            "memberGroups": [
                123,
                457
            ],
            "apps": [
                {
                    "clientId": "12345-c132-4b5e-9da4-7346437",
                    "customerId": 147,
                    "uaflag": 0,
                    "authorizedTimestamp": 1595268217,
                    "authorizedByUserId": 1,
                    "reason": "Automatic approval for everyone",
                    "appname": "Generic Mediahub",
                    "hasContributedData": 1406573883
                }
            ],
            "updatedAt": "2020-07-09T10:41:47.000Z",
            "createdAt": "2009-05-20T14:19:57.000Z"
        }
    ]
}

Create a new user

Update an existing user

Updates existing user data. This includes changes in regard to user-app-relations (e.g. adminLevel for a certain app or adding a new app for the user).

Example

Make a self-registered or IDP created mediahub user a regular (paid) one

PUT IAM/v1/user/:id
{
    "userappauthorization": {
        "clientId": "CLIENT-ID-OF-APP-TO_ADD",
        "reason": "Support request AC-123456",
        "flag": 0,
        "adminLevel": 0
    },
    // "securityGroupIds": [1] // optional, depending on app
}

Delete an existing user

Depending on several factors, the user will be marked as deleted, anonymized or finally deleted.

Generally, if you send a clientId with the delete request, only the relation between user and app (clientId) will be removed.

Bound to customer account

If a user is bound to a customer account (released is not set or 0), the customer account has all permissions to mange the user. If the user to be destroyed has contributed data to AdmiralCloud it will never be deleted but only anonymized (default setting) or just marked as deleted. Otherwise the user will be finally deleted. The same is true for user-app-relations: They will be marked as deleted (flag 99) if the user has contributed data to this app, otherwise the relation will be deleted from our database.

User without a customer account

If a user has no customer account or has been released destroying the user only has an affect on apps related to the customer account trying to destroy it. The user itself will never be changed or deleted. This kind of user can only delete themselves.

Anonymizing

If a user has contributed data, it is no longer possible to delete that user from the database. Instead, the default setting is to anonymize that user. The user will get a random name and firstname, as well as a random e-mail-address from domain “deactivatedusers.admiralcloud.com”. All settings of the user that can identify the user will be removed from the user model (e.g. individual configuration, location info).

Invite User

Find User AccessKeys

Get a list of user access keys. Please note that there can be only two (2) active user access keys per user. There are no parameters for this call

GET /v2/user/accessKeys

Create User AccessKeys

Create a new user access key. Please note that there can be only two (2) active user access keys per user.

Attention: This is the only time you can and will retrieve the access secret for this access key. We cannot recover this secret.

Update/Deactivate/Reactivate User AccessKeys

Use this endpoint to update notes for an existing access key. You can use it as well to deactivate or delete and access key or to reactivate a deactivated key.

Data Model

Legacy documentation

Flags

Every user has a flag which is an indicator of the origin of the user. The origin of a user is stored in field “origin”. As a user can be authorized for many apps, the flag is now on user-app-relation level (see introduction at the top of this article)