---
updatedAt: 2025-08-15T15:45:24.000Z
agentTools:
  projectIndex: https://docs.arcadia.com/v1.0-Utility-Cloud/llms.txt
---

# Create User

Create a User

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Utility Cloud",
    "description": "Utility Cloud",
    "version": "2.0"
  },
  "servers": [
    {
      "url": "https://api.urjanet.com/"
    }
  ],
  "paths": {
    "/users": {
      "post": {
        "tags": [
          "User Management"
        ],
        "description": "Create a User",
        "operationId": "Create User",
        "summary": "Create User",
        "requestBody": {
          "description": "userRequest",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PublicUserRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PublicUserResource"
                }
              }
            }
          }
        },
        "security": [
          {
            "BearerAuth": []
          },
          {
            "UnifiedAuth": []
          },
          {
            "APIKey": []
          }
        ]
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "x-amazon-apigateway-api-key-source": "AUTHORIZER",
  "x-amazon-apigateway-binary-media-types": [
    "application/pdf",
    "application/zip",
    "application/octet-stream"
  ],
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      },
      "UnifiedAuth": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header",
        "x-amazon-apigateway-authtype": "custom",
        "x-amazon-apigateway-authorizer": {
          "authorizerUri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:291789168161:function:${stageVariables.authenticatorFunctionName}/invocations",
          "authorizerCredentials": "arn:aws:iam::291789168161:role/${stageVariables.authenticatorRoleName}",
          "authorizerResultTtlInSeconds": 300,
          "type": "token"
        }
      },
      "APIKey": {
        "type": "apiKey",
        "name": "x-api-key",
        "in": "header"
      }
    },
    "schemas": {
      "PublicOrganizationResource": {
        "required": [
          "allowedEmailDomains",
          "connectEnabled",
          "connectParentWindowAddress",
          "connectParentWindowAddressAllowLocalhost",
          "connectPrimaryColor",
          "connectShowBeta",
          "connectShowMfa",
          "connectShowMock",
          "connectShowNonRtcv",
          "defaultDataCapturePeriodMonths",
          "defaultSolution",
          "defaultTimeout",
          "defaultWebhookUrl",
          "displayName",
          "name",
          "organizationType",
          "privacyPolicy",
          "publicKey",
          "sandboxWebhookUrl",
          "sourceToken",
          "termsOfService",
          "uniqueId",
          "useSourceToken"
        ],
        "type": "object",
        "properties": {
          "_links": {
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              },
              "users": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              }
            },
            "type": "object"
          },
          "allowedEmailDomains": {
            "type": "string"
          },
          "connectEnabled": {
            "type": "boolean"
          },
          "connectParentWindowAddress": {
            "type": "string"
          },
          "connectParentWindowAddressAllowLocalhost": {
            "type": "boolean"
          },
          "connectPrimaryColor": {
            "type": "string"
          },
          "connectShowBeta": {
            "type": "boolean"
          },
          "connectShowMfa": {
            "type": "boolean"
          },
          "connectShowMock": {
            "type": "boolean"
          },
          "connectShowNonRtcv": {
            "type": "boolean"
          },
          "createdDate": {
            "type": "string",
            "format": "date-time"
          },
          "createdBy": {
            "type": "string"
          },
          "defaultDataCapturePeriodMonths": {
            "type": "string"
          },
          "defaultSolution": {
            "type": "string"
          },
          "defaultTimeout": {
            "type": "string"
          },
          "defaultWebhookUrl": {
            "type": "string"
          },
          "isEnabled": {
            "type": "boolean"
          },
          "lastModifiedBy": {
            "type": "string"
          },
          "lastModifiedDate": {
            "type": "string",
            "format": "date-time"
          },
          "name": {
            "type": "string"
          },
          "organizationType": {
            "type": "string",
            "enum": [
              "LIVE",
              "SANDBOX"
            ]
          },
          "privacyPolicy": {
            "type": "string"
          },
          "publicKey": {
            "type": "string"
          },
          "sourceToken": {
            "type": "string"
          },
          "termsOfService": {
            "type": "string"
          },
          "uniqueId": {
            "type": "string"
          },
          "useSourceToken": {
            "type": "boolean"
          }
        },
        "title": "PublicOrganizationResource"
      },
      "PublicRoleResource": {
        "required": [
          "createdBy",
          "createdDate",
          "lastModifiedBy",
          "lastModifiedDate",
          "name"
        ],
        "type": "object",
        "properties": {
          "_links": {
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              }
            },
            "type": "object"
          },
          "createdBy": {
            "type": "string",
            "description": "User that created this role"
          },
          "createdDate": {
            "description": "Date that this role was created",
            "type": "string",
            "format": "date-time"
          },
          "lastModifiedBy": {
            "description": "User that most recently modified this role",
            "type": "string"
          },
          "lastModifiedDate": {
            "description": "Date this role was most recently modified",
            "type": "string",
            "format": "date-time"
          },
          "name": {
            "description": "Name of the role",
            "type": "string"
          }
        },
        "title": "PublicRoleResource"
      },
      "PublicUserRequest": {
        "type": "object",
        "required": [
          "accountEnabled",
          "credentialsExpired",
          "email",
          "name",
          "roles",
          "username"
        ],
        "properties": {
          "accountEnabled": {
            "description": "Indicates whether this user's account is enabled",
            "type": "boolean"
          },
          "autoGeneratePassword": {
            "description": "If true, password will be automatically set and user will have to reset it using associated e-mail address",
            "type": "boolean"
          },
          "credentialsExpired": {
            "description": "If true, this user needs to rotate their password",
            "type": "boolean"
          },
          "email": {
            "description": "E-mail address to associate with this user. The max length of this field is 100 characters.",
            "type": "string",
            "minLength": 0,
            "maxLength": 100
          },
          "name": {
            "description": "Full name of this user. The max length of this field is 100 characters.",
            "type": "string",
            "minLength": 0,
            "maxLength": 100,
            "pattern": "^[A-Za-z0-9 \\-]+$"
          },
          "organization": {
            "description": "ID of the Organization to which this user belongs. If left blank, user will be assigned to the current organization.",
            "type": "string"
          },
          "password": {
            "description": "Password used to authenticate with Urjanet. The min length of this field is 8 characters, and the max length is 60 characters.",
            "type": "string",
            "minLength": 8,
            "maxLength": 60
          },
          "passwordConfirm": {
            "type": "string",
            "description": "Confirm password used to authentica with Urjanet"
          },
          "roles": {
            "description": "List of IDs of the roles to assign to this user",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "username": {
            "description": "Username used to authenticate with Urjanet; cannot contain spaces. The min length of this field is 4, and max length is 50 characters.",
            "type": "string",
            "minLength": 4,
            "maxLength": 50,
            "pattern": "^[A-Za-z0-9_\\-\\.]+$"
          }
        },
        "title": "PublicUserRequest"
      },
      "PublicUserResource": {
        "required": [
          "createdBy",
          "createdDate",
          "email",
          "externalSource",
          "lastLoginAddress",
          "lastModifiedBy",
          "lastModifiedDate",
          "lastSuccessfulLogin",
          "links",
          "name"
        ],
        "type": "object",
        "properties": {
          "_embedded": {
            "properties": {
              "organization": {
                "$ref": "#/components/schemas/PublicOrganizationResource"
              },
              "roles": {
                "items": {
                  "$ref": "#/components/schemas/PublicRoleResource"
                },
                "type": "array"
              }
            },
            "type": "object"
          },
          "_links": {
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              },
              "edit": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              }
            },
            "type": "object"
          },
          "accountEnabled": {
            "type": "boolean",
            "description": "Indicates whether this user's account is enabled"
          },
          "createdBy": {
            "type": "string",
            "description": "User that created this user"
          },
          "createdDate": {
            "type": "string",
            "format": "date-time",
            "description": "Date the user was created"
          },
          "credentialsExpired": {
            "type": "boolean",
            "description": "If true, this user needs to rotate their password"
          },
          "email": {
            "type": "string",
            "description": "E-mail address associated with the user"
          },
          "externalSource": {
            "type": "string",
            "description": "N/A"
          },
          "lastLoginAddress": {
            "type": "string",
            "description": "Most recent address from which the user signed in",
            "nullable": true
          },
          "lastModifiedBy": {
            "type": "string",
            "description": "User that most recently made changes"
          },
          "lastModifiedDate": {
            "type": "string",
            "format": "date-time",
            "description": "Date the user was most recently modified"
          },
          "lastSuccessfulLogin": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "name": {
            "type": "string",
            "description": "Name of the user"
          },
          "username": {
            "type": "string",
            "description": "Username used to authenticate with Urjanet; cannot contain spaces"
          }
        },
        "title": "PublicUserResource"
      }
    }
  },
  "tags": [
    {
      "name": "User Management"
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true,
    "samples-enabled": true
  }
}
```