Create/Update User

Endpoint: PUT /api/users/{id}

Creates or updates a user in your Conductor cluster. The invoking user must be an Admin to the Conductor cluster.

Path parameters

Parameter	Description	Type	Required/ Optional
id	The user's email address.	string	Required

Request body

Parameter	Description	Type	Required/ Optional
name	A display name for the user.	string	Required.
roles	The role to assign for the user. Supported values: ADMIN: Superuser. Full access to the system and resources. Can manage users and groups. USER: Regular user group with permissions to create workflow definitions, task definitions, applications, integrations, secrets, and user forms. Has full API Gateway access, including view and management permissions. Can search workflows. METADATA_MANAGER: Can manage all workflow and task definitions in the cluster, including performing any action regardless of workflow or task ownership. Can view and manage API Gateway configurations. Can create integrations and secrets. WORKFLOW_MANAGER: Can view, execute, and manage all workflow executions in the system, including start, pause, resume, rerun, retry, restart, terminate, and delete actions. Has execute and read access to workflow and task definitions. USER_READ_ONLY: Can view applications, metadata, workflows, API gateway, and search workflows.	string	Required.
groups	The groups that the user should be part of. This provides additional group-level permissions to the user.	string	Optional.

Response

Returns the created or updated user object, including the user's id, name, roles, and groups. Returns 403 if the invoking user is not an Admin.

Examples

Create a new user

Request

curl -X 'PUT' \
  'https://<YOUR-SERVER-URL>/api/users/user%40example.com' \
  -H 'accept: application/json' \
  -H 'X-Authorization: <TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "John Doe",
  "roles": [
    "ADMIN"
  ]
}'

Response

{
  "id": "user@example.com",
  "name": "John Doe",
  "roles": [
    {
      "name": "ADMIN",
      "permissions": [
        {
          "name": "METADATA_MANAGEMENT"
        },
        {
          "name": "ADMIN_MANAGEMENT"
        },
        {
          "name": "METADATA_VIEW"
        },
        {
          "name": "PERMISSION_MANAGEMENT"
        },
        {
          "name": "USER_MANAGEMENT"
        },
        {
          "name": "EVENT_HANDLER_MANAGEMENT"
        },
        {
          "name": "PROMPT_MANAGEMENT"
        },
        {
          "name": "WORKFLOW_MANAGEMENT"
        },
        {
          "name": "API_GATEWAY_MANAGEMENT"
        },
        {
          "name": "API_GATEWAY_VIEW"
        },
        {
          "name": "PUBLISHER_MANAGEMENT"
        },
        {
          "name": "WORKFLOW_SEARCH"
        },
        {
          "name": "AUTHORIZATION_MANAGEMENT"
        },
        {
          "name": "SCHEDULE_MANAGEMENT"
        },
        {
          "name": "BULK_MANAGEMENT"
        },
        {
          "name": "APPLICATION_MANAGEMENT"
        }
      ]
    }
  ],
  "groups": [],
  "uuid": "20d6f75b-38ba-48a4-aedd-5a1acc65c15f",
  "contactInformation": {},
  "applicationUser": false,
  "orkesWorkersApp": false,
  "orkesApiGateway": false,
  "orkesApp": false
}

Update an existing user

Request

curl -X 'PUT' \
  'https://<YOUR-SERVER-URL>/api/users/user%40example.com' \
  -H 'accept: application/json' \
  -H 'X-Authorization: <TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "John Doe",
  "roles": [
    "ADMIN"
  ],
  "groups": [
    "TechWriters"
  ]

}'

Response

{
  "id": "user@example.com",
  "name": "John Doe",
  "roles": [
    {
      "name": "ADMIN",
      "permissions": [
        {
          "name": "API_GATEWAY_VIEW"
        },
        {
          "name": "API_GATEWAY_MANAGEMENT"
        },
        {
          "name": "WORKFLOW_MANAGEMENT"
        },
        {
          "name": "PROMPT_MANAGEMENT"
        },
        {
          "name": "EVENT_HANDLER_MANAGEMENT"
        },
        {
          "name": "USER_MANAGEMENT"
        },
        {
          "name": "PERMISSION_MANAGEMENT"
        },
        {
          "name": "METADATA_VIEW"
        },
        {
          "name": "ADMIN_MANAGEMENT"
        },
        {
          "name": "METADATA_MANAGEMENT"
        },
        {
          "name": "APPLICATION_MANAGEMENT"
        },
        {
          "name": "BULK_MANAGEMENT"
        },
        {
          "name": "SCHEDULE_MANAGEMENT"
        },
        {
          "name": "AUTHORIZATION_MANAGEMENT"
        },
        {
          "name": "WORKFLOW_SEARCH"
        },
        {
          "name": "PUBLISHER_MANAGEMENT"
        }
      ]
    }
  ],
  "groups": [
    {
      "id": "TechWriters",
      "description": "A dedicated group for testing for tech writers",
      "roles": [
        {
          "name": "METADATA_MANAGER",
          "permissions": [
            {
              "name": "API_GATEWAY_MANAGEMENT"
            },
            {
              "name": "CREATE_INTEGRATION"
            },
            {
              "name": "CREATE_SECRET"
            },
            {
              "name": "METADATA_VIEW"
            },
            {
              "name": "METADATA_MANAGEMENT"
            },
            {
              "name": "API_GATEWAY_VIEW"
            }
          ]
        }
      ],
      "defaultAccess": {},
      "contactInformation": {}
    }
  ],
  "uuid": "20d6f75b-38ba-48a4-aedd-5a1acc65c15f",
  "contactInformation": {},
  "orkesWorkersApp": false,
  "orkesApiGateway": false,
  "applicationUser": false,
  "orkesApp": false
}