Last updated: September 23, 2026

Create Custom Role

Create Custom Role.

Request

POSThttps://superadminuser.miniorange.in/services/api/directory/v1/admin/roles

Authentication headers (required on every request)

Customer-Key
Super Admin ID for the actor account.
Timestamp
Milliseconds since epoch (e.g. Date.now()).
Authorization
SHA-512 of superAdminId + timestamp + apiKey.
X-Target-Customer-Id
Customer tenant the Super Admin is acting on.

Parameters

NameTypeRequiredDescription
roleNameStringOptional
adminCapabilitiesStringOptional
endUserCapabilitiesStringOptional
customCapabilitiesStringOptional

Request body

{
    "roleName": "My Custom Admin Role",
    "adminCapabilities": {
        "user_manage_view": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "user_manage_view",
            "isAllowed": true,
            "titleText": "View Users"
        },
        "user_manage_add": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "user_manage_add",
            "isAllowed": true,
            "titleText": "Add Users"
        },
        "user_manage_edit": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "user_manage_edit",
            "isAllowed": true,
            "titleText": "Edit Users"
        },
        "user_manage_delete": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "user_manage_delete",
            "isAllowed": false,
            "titleText": "Delete Users"
        },
        "user_manage_admindelete": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "user_manage_admindelete",
            "isAllowed": false,
            "titleText": "Delete other Admins"
        },
        "user_manage_disableEnable": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "user_manage_disableEnable",
            "isAllowed": true,
            "titleText": "Disable/Enable Users"
        },
        "user_manage_role": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "user_manage_role",
            "isAllowed": true,
            "titleText": "Manage User Roles"
        },
        "user_manage_activeSession": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "user_manage_activeSession",
            "isAllowed": true,
            "titleText": "Manage User Active Sessions"
        },
        "user_impersonation": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "user_impersonation",
            "isAllowed": false,
            "titleText": "Impersonate users"
        },
        "group_manage_view": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "group_manage_view",
            "isAllowed": true,
            "titleText": "View Groups"
        },
        "group_manage_add": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "group_manage_add",
            "isAllowed": true,
            "titleText": "Add Groups"
        },
        "group_manage_edit": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "group_manage_edit",
            "isAllowed": true,
            "titleText": "Edit Groups"
        },
        "group_manage_delete": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "group_manage_delete",
            "isAllowed": false,
            "titleText": "Delete Groups"
        },
        "group_manage_assign": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "group_manage_assign",
            "isAllowed": true,
            "titleText": "Assign/Deassign Users to/from a group"
        },
        "apps_manage_view": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "apps_manage_view",
            "isAllowed": true,
            "titleText": "View Application"
        },
        "apps_manage_add": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "apps_manage_add",
            "isAllowed": true,
            "titleText": "Add Application"
        },
        "apps_manage_edit": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "apps_manage_edit",
            "isAllowed": true,
            "titleText": "Edit Application"
        },
        "apps_manage_delete": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "apps_manage_delete",
            "isAllowed": false,
            "titleText": "Delete Application"
        },
        "policies_app": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "policies_app",
            "isAllowed": true,
            "titleText": "Manage App Policies"
        },
        "report_view_auditReport": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "report_view_auditReport",
            "isAllowed": true,
            "titleText": "Audit Report"
        },
        "report_view_userLogin": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "report_view_userLogin",
            "isAllowed": true,
            "titleText": "User Login Report"
        },
        "mfa_setup_customer": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "mfa_setup_customer",
            "isAllowed": true,
            "titleText": "Setup Two Factor"
        },
        "mfa_setup_options": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "mfa_setup_options",
            "isAllowed": true,
            "titleText": "Manage 2FA options for Enduser"
        },
        "authsource_idp_view": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "authsource_idp_view",
            "isAllowed": true,
            "titleText": "View Identity Providers"
        },
        "authsource_store_view": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "authsource_store_view",
            "isAllowed": true,
            "titleText": "View External Directories"
        },
        "provisioning_manage": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "provisioning_manage",
            "isAllowed": true,
            "titleText": "Manage User Provisioning"
        },
        "branding_edit": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "branding_edit",
            "isAllowed": false,
            "titleText": "Edit Branding Settings"
        },
        "miscellaneous_dashboard": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "miscellaneous_dashboard",
            "isAllowed": true,
            "titleText": "Dashboard Access"
        },
        "miscellaneous_settings_product": {
            "isDefault": "CUSTOMER_SUPER_ADMIN",
            "userCapability": "miscellaneous_settings_product",
            "isAllowed": true,
            "titleText": "Show Product Settings"
        }
    },
    "endUserCapabilities": {
        "dashboard_access": {
            "isDefault": "END_USER",
            "userCapability": "dashboard_access",
            "isAllowed": true,
            "titleText": "Dashboard Access"
        },
        "setup_two_factor": {
            "isDefault": "END_USER",
            "userCapability": "setup_two_factor",
            "isAllowed": true,
            "titleText": "Setup Two Factor"
        },
        "access_profile_page": {
            "isDefault": "END_USER",
            "userCapability": "access_profile_page",
            "isAllowed": true,
            "titleText": "Allow Access to User's Profile Page"
        },
        "app_section_access": {
            "isDefault": "END_USER",
            "userCapability": "app_section_access",
            "isAllowed": false,
            "titleText": "Access to App Section"
        },
        "allow_users_to_change_password": {
            "isDefault": "END_USER",
            "userCapability": "allow_users_to_change_password",
            "isAllowed": true,
            "titleText": "Allow users to change the password"
        },
        "allow_users_to_change_email": {
            "isDefault": "END_USER",
            "userCapability": "allow_users_to_change_primary_mail",
            "isAllowed": true,
            "titleText": "Allow users to change the Email"
        }
    },
    "customCapabilities": {
        "my_custom_capability_1": {
            "isDefault": "CUSTOM",
            "userCapability": "my_custom_capability_1",
            "isAllowed": true,
            "titleText": "My Custom Feature Access",
            "category": "Custom",
            "description": "Allows access to my custom feature"
        }
    }
}

No sample response is documented for this endpoint yet. Use Try it on the right to see the live response from your tenant.

Copied