API REFERENCE
Overview & AuthenticationUsers & GroupsRunbooksJob RunsPipelinesSchedulesApprovals & Self-ServiceRunners & Runner GroupsAutomation SetsAccess Types, Packages & ListsTargets, Hosts & LookupsConfiguration & NotificationsRuntime Images & RealmsBackup, Health & Time

Users & Groups

13 endpoints discovered from this archive’s backend.

Set these variables first
export ALPHIE_URL="https://YOUR-ALPHIE-HOST"
export ALPHIE_TOKEN="PASTE_YOUR_API_TOKEN_HERE"
# Requires a certificate trusted by your machine. For test-only self-signed certificates,
# use curl --cacert /path/to/alphie.crt (preferred) rather than disabling TLS verification.

Most authenticated endpoints accept Authorization: Bearer $ALPHIE_TOKEN. Endpoints can still require administrator permissions or particular roles. API tokens must be provisioned through an authorized Alphie account; don't put secrets in playbooks, logs, or browser-side forms.

POST/api/admin/change-password

Change password

curl --fail-with-body -sS -X POST "$ALPHIE_URL/api/admin/change-password" \
  -H "Authorization: Bearer $ALPHIE_TOKEN" \n  -H "Content-Type: application/json" \n  --data-binary @request.json

Body example: supply a request.json file matching this endpoint’s request model. Consult $ALPHIE_URL/openapi.json for required fields.

GET/api/admin/groups

List groups

curl --fail-with-body -sS -X GET "$ALPHIE_URL/api/admin/groups" \
  -H "Authorization: Bearer $ALPHIE_TOKEN"

POST/api/admin/groups

Create group

curl --fail-with-body -sS -X POST "$ALPHIE_URL/api/admin/groups" \
  -H "Authorization: Bearer $ALPHIE_TOKEN" \n  -H "Content-Type: application/json" \n  --data-binary @request.json

Body example: supply a request.json file matching this endpoint’s request model. Consult $ALPHIE_URL/openapi.json for required fields.

DELETE/api/admin/groups/{group_id}

Delete group

curl --fail-with-body -sS -X DELETE "$ALPHIE_URL/api/admin/groups/${GROUP_ID}" \
  -H "Authorization: Bearer $ALPHIE_TOKEN"

GET/api/admin/groups/{group_id}

Get group

curl --fail-with-body -sS -X GET "$ALPHIE_URL/api/admin/groups/${GROUP_ID}" \
  -H "Authorization: Bearer $ALPHIE_TOKEN"

POST/api/admin/groups/{group_id}/assign

Assign users to group

curl --fail-with-body -sS -X POST "$ALPHIE_URL/api/admin/groups/${GROUP_ID}/assign" \
  -H "Authorization: Bearer $ALPHIE_TOKEN" \n  -H "Content-Type: application/json" \n  --data-binary @request.json

Body example: supply a request.json file matching this endpoint’s request model. Consult $ALPHIE_URL/openapi.json for required fields.

POST/api/admin/groups/{group_id}/remove

Remove users from group

curl --fail-with-body -sS -X POST "$ALPHIE_URL/api/admin/groups/${GROUP_ID}/remove" \
  -H "Authorization: Bearer $ALPHIE_TOKEN" \n  -H "Content-Type: application/json" \n  --data-binary @request.json

Body example: supply a request.json file matching this endpoint’s request model. Consult $ALPHIE_URL/openapi.json for required fields.

GET/api/admin/users

List users

curl --fail-with-body -sS -X GET "$ALPHIE_URL/api/admin/users" \
  -H "Authorization: Bearer $ALPHIE_TOKEN"

POST/api/admin/users

Create user

curl --fail-with-body -sS -X POST "$ALPHIE_URL/api/admin/users" \
  -H "Authorization: Bearer $ALPHIE_TOKEN" \n  -H "Content-Type: application/json" \n  --data-binary @request.json

Body example: supply a request.json file matching this endpoint’s request model. Consult $ALPHIE_URL/openapi.json for required fields.

DELETE/api/admin/users/{user_id}

Delete user

curl --fail-with-body -sS -X DELETE "$ALPHIE_URL/api/admin/users/${USER_ID}" \
  -H "Authorization: Bearer $ALPHIE_TOKEN"

GET/api/admin/users/{user_id}

Get user

curl --fail-with-body -sS -X GET "$ALPHIE_URL/api/admin/users/${USER_ID}" \
  -H "Authorization: Bearer $ALPHIE_TOKEN"

PUT/api/admin/users/{user_id}

Update user

curl --fail-with-body -sS -X PUT "$ALPHIE_URL/api/admin/users/${USER_ID}" \
  -H "Authorization: Bearer $ALPHIE_TOKEN" \n  -H "Content-Type: application/json" \n  --data-binary @request.json

Body example: supply a request.json file matching this endpoint’s request model. Consult $ALPHIE_URL/openapi.json for required fields.

GET/profile.html

Serve the protected profile page

curl --fail-with-body -sS -X GET "$ALPHIE_URL/profile.html" \
  -H "Authorization: Bearer $ALPHIE_TOKEN"