---
title: User Roles
slug: ps/help/en_us/ics/com/api/user-roles
docTags: 
createdAt: 2026-08-02T14:28:52.932Z
---

To get APIs for all roles:

```bash
/api/v1/configuration/users/user-roles
```

Under Roles following default roles available:

- /api/v1/configuration/users/user-roles/user-role/Users
- /api/v1/configuration/users/user-roles/user-role/Guest Sponsor
- /api/v1/configuration/users/user-roles/user-role/Guest Wired Restricted
- /api/v1/configuration/users/user-roles/user-role/Guest Admin
- /api/v1/configuration/users/user-roles/user-role/Guest
- /api/v1/configuration/users/user-roles/user-role-default-options

To create a role:

```python
POST 
api/v1/configuration/users/user-roles/user-role/HTTP/1.1
Host xx.xx.xx.xx
Authorization: Basic
Content-Type: application/json
{

    "agent": {

        "agent-type": "install-pulse",

        "host-enforcer": "false",

        "install-agent": "true",

        "pulse-settings": {

            "client-components": "Default",

            "integration": "false"

        },

        "win-session-start-script": "",

        "win-session-stop-script": ""

    },

    "agentless": {

        "agentless-access": "false",

        "disable-ajax": "false",

        "hide-agentless-page": "false"

    },

    "enterprise-onboarding": {

        "auto-launch": "false",

        "install-junospulse": "false",

        "redirect-mdm-server-url": "",

        "use-tpmdm-onboard": "false"

    },

    "general": {

        "overview": {

            "description": "",

            "enterprise-onboarding": {

                "enterprise-onboarding-enabled": "false"

            },

            "options": {

                "guest-account-management-rights": "false",

                "guest-sponsor-management-rights": "false",

                "junos-pulse": "true",

                "session-options": "true",

                "ui-options": "true"

            }

        },

        "restrictions": {

            "browser": {

                "customized": "any-user-agent",

                "user-agent-patterns": {

                    "user-agent-pattern": []

                }

            },

            "certificate": {

                "cert-key-value-pairs": {

                    "cert-key-value-pair": []

                },

                "customized": "allow-all-users"

            },

            "host-checker": {

                "host-check-enforce": "disable",

                "host-check-match": "all",

                "host-check-policies": null

            },

            "mobile": {

                "server-certificate-trust-enforcement": "disable",

                "touch-id-supported": "disable"

            },

            "source-ip": {

                "customized": "any-ip",

                "ips": {

                    "ip": []

                }

            }

        },

        "session-options": {

            "auth-table-timeout": "60",

            "heartbeat-interval": "900",

            "heartbeat-timeout": "1800",

            "http-only-device-cookie": "enabled",

            "max-timeout": "725",

            "netmask": "255.255.255.255",

            "prefix": "64",

            "reminder-time": "5",

            "roaming": "disabled",

            "session-extension": "false",

            "session-timeout-warning": "false",

            "traffic-as-heartbeat": "false",

            "use-auth-srvr-attr-for-session-mgmt": "false"

        },

        "ui-options": {

            "accordion-view": "Block",

            "always-show-notification-nc": "false",

            "browsing-toolbar-withiframe": "false",

            "compliance-failure-message": "You have limited connectivity because your device does not meet compliance policies.",

            "display-session-counter": "false",

            "guam-bulk-creation-enabled": "true",

            "guam-instruction-message": "",

            "header-background-color": "#FFFFFF",

            "instruction-message": "Welcome to the Ivanti Policy Secure. Do not navigate away from this page, or you will lose access to protected resources.",

            "notification-message": "",

            "onboarding-messages": {

                "android-and-iOS-secure-mail-disabled": {

                    "download-configuration-profile": ""

                },

                "android-and-iOS-secure-mail-enabled": {

                    "install-junos-pulse": ""

                },

                "welcome-message": "",

                "windows": {

                    "download-application": "",

                    "post-downloading": ""

                }

            },

            "show-compliance-failure": "false",

            "show-copyright": "true",

            "show-guam-instruction": "false",

            "show-instruction": "true",

            "show-notification": "false",

            "show-notification-nc": "false",

            "signin-notification-id": "None"

        }

    },

    "name": "testRole"

}
```