---
updatedAt: 2025-10-22T13:00:49.000Z
---

# Create User Profile

Creates a new User Profile with Entity and Log Source restrictions.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "LogRhythm Admin Service API",
    "version": "9.175.0",
    "description": "This file describes the available endpoints for administering a LogRhythm deployment. For more information about tokens, security, and registering third party applications, see the documentation available at https://docs.logrhythm.com/docs/lrapi/administration-api."
  },
  "tags": [
    {
      "name": "users",
      "description": "User Records identify users and are used for alarm notifications. User Profiles enable group access permissions for hosts and log sources."
    }
  ],
  "x-tagGroups": [
    {
      "name": "Administration",
      "tags": [
        "lists",
        "identities",
        "identity lists",
        "entities",
        "hosts",
        "networks",
        "license",
        "users",
        "notification groups",
        "logsources",
        "agents",
        "beats",
        "openCollectors"
      ]
    },
    {
      "name": "knowledgebase",
      "tags": [
        "locations",
        "logSourceTypes",
        "mpePolicies",
        "messagesourcedateformats",
        "lsvtemplates",
        "mperules",
        "knowledgebase"
      ]
    }
  ],
  "paths": {
    "/user-profiles": {
      "x-swagger-router-controller": "userManagement",
      "post": {
        "tags": [
          "users"
        ],
        "summary": "Create User Profile",
        "description": "Creates a new User Profile with Entity and Log Source restrictions.",
        "operationId": "createUserProfile",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UserProfile"
              }
            }
          },
          "description": "The body of the new User Profile. Any value in Id field is ignored.",
          "required": true
        },
        "security": [
          {
            "Bearer": []
          }
        ],
        "responses": {
          "201": {
            "description": "Returns the newly created User Profile.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UserProfile"
                }
              }
            }
          },
          "401": {
            "description": "Validation failure or system is unable to create a new User Profile.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/apiUserError"
                }
              }
            }
          },
          "409": {
            "description": "Resource already exists.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/apiUserError"
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://localhost:8501/lr-admin-api",
      "description": "Local API Gateway (https)"
    }
  ],
  "components": {
    "securitySchemes": {
      "Bearer": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header",
        "description": "Authenticate using a JSON Web Token (JWT)."
      }
    },
    "schemas": {
      "apiUserError": {
        "type": "object",
        "properties": {
          "statusCode": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "source": {
            "type": "string"
          },
          "details": {
            "type": "string"
          },
          "upstreamError": {
            "type": "string"
          }
        }
      },
      "UserProfileSummary": {
        "type": "object",
        "required": [
          "name",
          "dataProcessorAccessMode",
          "securityRole"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "description": "The User Profile Id stored in the system."
          },
          "name": {
            "type": "string",
            "description": "The User Profile name.",
            "minLength": 1,
            "maxLength": 100,
            "x-omitempty": true
          },
          "shortDescription": {
            "type": "string",
            "description": "A short description of the User Profile.",
            "maxLength": 255,
            "x-omitempty": true
          },
          "longDescription": {
            "type": "string",
            "description": "A detailed description of the User Profile.",
            "maxLength": 2000,
            "x-omitempty": true
          },
          "dataProcessorAccessMode": {
            "type": "string",
            "description": "Data Processor access mode for the User Profile.",
            "enum": [
              "None",
              "All",
              "Specific",
              "OnlineActive",
              "OnlineArchive"
            ],
            "x-omitempty": true
          },
          "securityRole": {
            "type": "string",
            "description": "The User Profile Role type. Customers can create only GlobalAdmin, GlobalAnalyst, RestrictedAdmin and RestrictedAnalysts profiles, according to their permissions.",
            "enum": [
              "None",
              "GlobalAdmin",
              "GlobalAnalyst",
              "GlobalMedSvr",
              "GlobalMPE",
              "GlobalARM",
              "RestrictedAnalyst",
              "SuperUser",
              "WebServiceAdmin",
              "GlobalWebUI",
              "RestrictedAdmin"
            ],
            "x-omitempty": true
          },
          "adgroupNotificationGroupName": {
            "type": "string",
            "description": "The AD Notification Group name.",
            "x-omitempty": true
          },
          "adgroupNotificationGroupId": {
            "type": "integer",
            "description": "The AD Notification Group Id.",
            "x-omitempty": true,
            "nullable": true
          },
          "shouldSyncADgroupContacts": {
            "type": "boolean",
            "description": "Syncs AD group contacts if checked.",
            "x-omitempty": true
          },
          "ProfileType": {
            "type": "string",
            "description": "Indicates allowed profile or denied profile. Access to log sources associated with an allowed Entity is based on User profile type.",
            "enum": [
              "Allow",
              "Deny"
            ],
            "x-omitempty": true
          },
          "dateUpdated": {
            "type": "string",
            "format": "date-time",
            "description": "The date when the Notifcation Group was modified. Shows creation date if recently created.",
            "x-omitempty": true
          },
          "totalAssociatedUsers": {
            "type": "integer",
            "description": "The number of users associated with the Profile.",
            "x-omitempty": true
          }
        }
      },
      "UserProfile": {
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/UserProfileSummary"
          }
        ],
        "properties": {
          "adGroupsPermissions": {
            "x-omitempty": true,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UserProfileADGroup"
            }
          },
          "entityPermissions": {
            "x-omitempty": true,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UserProfileEntityPermSummary"
            }
          },
          "dataProcessorsPermissions": {
            "x-omitempty": true,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UserProfileDPPerm"
            }
          },
          "logsourceListPermissions": {
            "x-omitempty": true,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UserProfileLSListPerm"
            }
          },
          "logSourcePermissions": {
            "x-omitempty": true,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UserProfileLSPerm"
            }
          },
          "privileges": {
            "x-omitempty": true,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UserProfilePrivilege"
            }
          },
          "smartResponsePluginsPermissions": {
            "x-omitempty": true,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ObjectToUserProfileMapping"
            }
          },
          "notificationGroupsPermissions": {
            "x-omitempty": true,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/NotificationGroupToUserProfileMapping"
            }
          }
        }
      },
      "UserProfileADGroup": {
        "type": "object",
        "properties": {
          "domainId": {
            "type": "integer",
            "description": "The Active Directory domain Id."
          },
          "domainName": {
            "type": "string",
            "description": "The Active Directory domain name.",
            "x-omitempty": true
          },
          "groupId": {
            "type": "integer",
            "description": "The Active Directory group Id."
          },
          "groupName": {
            "type": "string",
            "description": "The Active Directory group name.",
            "x-omitempty": true
          }
        }
      },
      "UserProfileEntityPermSummary": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The Entity Id associated with the User Profile."
          },
          "name": {
            "type": "string",
            "description": "The name of the Entity.",
            "x-omitempty": true
          }
        }
      },
      "UserProfileDPPerm": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The Data Processor associated with the User Profile."
          },
          "name": {
            "type": "string",
            "description": "The name of the Data Processor.",
            "x-omitempty": true
          }
        }
      },
      "UserProfileLSListPerm": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The list associated with the User Profile."
          },
          "name": {
            "type": "string",
            "description": "The name of the list.",
            "x-omitempty": true
          }
        }
      },
      "UserProfileLSPerm": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The list associated with the User Profile."
          },
          "name": {
            "type": "string",
            "description": "The name of the list.",
            "x-omitempty": true
          }
        }
      },
      "UserProfilePrivilege": {
        "type": "string",
        "description": "The privilege key.",
        "x-omitempty": true,
        "enum": [
          "ShowDeploymentManager",
          "ShowEntityMgr",
          "EntityMgmt",
          "ShowAgentAgentMgr",
          "AgentMgmt",
          "ShowLSMgr",
          "LSMgmt",
          "ShowAlarmMgr",
          "AlarmMgmt",
          "ShowListMgr",
          "ListMgmt",
          "ShowPersonalDashboard",
          "ShowInvestigation",
          "ShowTails",
          "ReportMgmt",
          "ScheduleReport",
          "MPERuleBuilderMgmt",
          "CommonEventMgmt",
          "AgentPackageMgmt",
          "AgentConfigMgmt",
          "ReOrgMgmt",
          "MyPreferenceMgmt",
          "PersonalAlarmMgmt",
          "ShowLicenseReport",
          "SecondLookMgmt",
          "DPMgmt",
          "PMMgmt",
          "AieServerMgmt",
          "AIeWorkLoadMgmt",
          "AIERuleMgmt",
          "NMMgmt",
          "LPPMgmt",
          "UserProfileMgmt",
          "UserMgmt",
          "ShowDepMon",
          "ApplicationMgmt",
          "LSTMgmt",
          "ADManagement",
          "CEChangeMgmt",
          "KBMgmt",
          "WHWMgmt",
          "GlprMgmt",
          "DmrMgmt",
          "SrpMgmt",
          "DldpolicyMgmt",
          "FimMgmt",
          "RimMgmt",
          "LsvMgmt",
          "AalprMgmt",
          "OpMgmt",
          "SecurityMgmt",
          "NotificationMgmt",
          "LdsMgmt",
          "LdsServiceMgmt",
          "AutomaticlsconfigMgmt",
          "AIEActionsMgmt",
          "AlarmActionsMgmt",
          "FilterMgmt",
          "AgentConfigMgmtUpsert",
          "AieEngineMgmt",
          "ImportLicensefile",
          "CloudAIAccess",
          "GlobalAIEEventsAccess",
          "LogRhythmAPIAccess",
          "CaseMgmtAccess",
          "TrueIdentityMgmt",
          "DBUsageWidgetWC",
          "ComponentStatusWidgetWC",
          "ProcessingWidgetWC",
          "ThreatMapWidgetWC",
          "ManageTagsWC",
          "ManageCaseWidgetsWC",
          "ManageAllCasesWC",
          "ShowOCAndBeatsMgr",
          "OCAndBeatsMgmt"
        ]
      },
      "ObjectToUserProfileMapping": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The SmartResponse plugin Id."
          },
          "name": {
            "type": "string",
            "description": "The name of the SmartResponse plugin.",
            "x-omitempty": true
          }
        }
      },
      "NotificationGroupToUserProfileMapping": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "notification group id"
          },
          "name": {
            "type": "string",
            "description": "Name of the notification group",
            "x-omitempty": true
          }
        }
      }
    }
  }
}
```