User Management API

LIMITED TO ENTERPRISE PACK

This feature is limited to the Paradime Enterprise Pack.

With the user management APIs, you can access a set of GraphQL APIs tailored specifically for managing users in you Paradime workspace. These APIs streamline user activities, permissions, and interactions, simplifying integration and administration.

The below API are scoped at a workspace level. If using multiple workspaces you will need to use different API credentials in the Authorization headers.

Requirements

To authenticate an application with the Paradime API, you will need to provide in the Authorization headers:

  • X-API-KEY

  • X-API-SECRET

Generate API keys

API endpoints

List Workspaces

This API return details on the current active workspaces in your Paradime Account

query ListWorkspaces {
    listWorkspaces {
        ok
        workspaces {
            name
            uid
        }
    }
}

List Users

This API return a list of all the current active and invited users in your workspace

query ListUsers {
    listUsers {
        ok
        activeUsers {
            uid
            email
            name
            accountType
        }
        invitedUsers {
            email
            accountType
            inviteStatus
        }
    }
}

Invite Users

This API enable you to invite user programmatically to your workspace.

mutation InviteUser {
    inviteUser(email: "snow@paradime.io", accountType: DEVELOPER) {
        ok
    }
}

User AccountType can be one of:

  • ADMIN

  • WORKSPACE_ADMIN *

  • DEVELOPER

  • ANALYST *

  • BUSINESS

  • WORKSPACE_SETTINGS_ADMIN *

  • SECURITY_ADMIN *

  • BILLING_ADMIN *

Role Types with marked with (*) are available only on the Paradime Security Pack.

Update user Role

This API enable you to update the role of a current signed up user in your workspace.

mutation UpdateUserAccountType {
    updateUserAccountType(
        uid: "316ae4b506ad623b3726e38e4ff9361581f78a6a65ac61c101e65f4047cce09a"
        accountType: ADMIN
    ) {
        ok
    }
}

UserAccountType can be one of:

  • ADMIN

  • WORKSPACE_ADMIN *

  • DEVELOPER

  • ANALYST *

  • BUSINESS

  • WORKSPACE_SETTINGS_ADMIN *

  • SECURITY_ADMIN *

  • BILLING_ADMIN *

Role Types with marked with (*) are available only on the Paradime Security Pack.

Disable user

This API enable you to disable a user from your workspace.

mutation DisableUser {
    disableUser(uid: "316ae4b506ad623b3726e38e4ff9361581f78a6a65ac61c101e65f4047cce09a") {
        ok
    }
}

Last updated