Admin Commands
Perform bulk user management operations across ACCποΈACCAutodesk's construction management platform.View in glossary/BIM 360π΅BIM 360Legacy Autodesk construction platform (predecessor to ACC).View in glossary accounts. These commands enable efficient onboarding, offboarding, and permission management at scale.
Note: Admin commands require Account Administrator role in ACC/BIMποΈBIMIntelligent 3D model-based design for buildings.View in glossary 360. Run
raps auth loginfirst. SetAPS_ACCOUNT_IDor use--accountto specify your account.
Commands Overview
| CommandβΆοΈCommandInstruction executed by a CLI tool.View in glossary | Description |
|---|---|
raps admin user add | [bulk] Add user to multiple projects |
raps admin user remove | [bulk] Remove user from projects |
raps admin user update | [bulk] Update user role and/or company across projects |
raps admin user add-to-all-projects | Add user to all active projects with an optional role |
raps admin user create | Create (invite) a user at the account level |
raps admin user get | Get user details by user ID |
raps admin user update-account | Update a userβs account-level settings (company, status) |
raps admin user list | List users in account or projectπProjectContainer for folders and files within a hub.View in glossary |
raps admin user import | Import users to a project from CSVπCSVTabular data format for spreadsheets.View in glossary |
raps admin folder set-permissions | Set folder permissions across projects |
raps admin project get | Get project details by ID |
raps admin project list | List projects with filtering |
raps admin project create | Create a new project |
raps admin project create-batch | [bulk] Create multiple projects in parallel |
raps admin project update | Update project settings |
raps admin project archive | Archive a project |
raps admin company list | List companies in an account |
raps admin company get | Get company details by ID |
raps admin company search | Search companies by name |
raps admin company create | Create a new company |
raps admin company update | Update company details |
raps admin operation status | View operation progress |
raps admin operation resume | Resume interrupted operation |
raps admin operation cancel | Cancel in-progress operation |
raps admin operation list | List all operations |
User Commands
raps admin user add
Add a user to multiple projects with a specified role.
raps admin user add [OPTIONS] <EMAIL>
Arguments:
EMAIL- User email address to add
Options:
-a, --account <ACCOUNT>- Account ID (defaults to current profileπ€ProfileNamed set of configuration settings.View in glossary account)-r, --role <ROLE>- Role to assign (e.g.,"Project Admin","Document Manager")-f, --filter <FILTER>- Filter expression (e.g.,"name:*Hospital*,status:active")--project-ids <FILE>- File containing project IDs (one per line)--concurrency <N>- Parallel requests (max: 50)--dry-run- Preview changes without executing--output <FORMAT>- Output format (table, jsonπJSONStandard data interchange format.View in glossary, yamlπYAMLHuman-readable configuration format.View in glossary, csv, plain)
Example:
$ raps admin user add "user@company.com" --account "acc-123" --role "Project Admin"
Adding user to projects...
[ββββββββββββββββββββββββββββββββββββββββ] 100/100
Results:
ββββββββββββββββ¬ββββββββ
β Status β Count β
ββββββββββββββββΌββββββββ€
β Succeeded β 95 β
β Skipped β 3 β
β Failed β 2 β
ββββββββββββββββ΄ββββββββ
raps admin user remove
Remove a user from multiple projects.
raps admin user remove [OPTIONS] <EMAIL>
Arguments:
EMAIL- User email address to remove
Options:
-a, --account <ACCOUNT>- Account ID-f, --filter <FILTER>- Filter expression--project-ids <FILE>- File containing project IDs (one per line)--concurrency <N>- Parallel requests (max: 50)--dry-run- Preview changes without executing--output <FORMAT>- Output format
Example:
$ raps admin user remove "departed@company.com" --account "acc-123"
Removing user from projects...
[ββββββββββββββββββββββββββββββββββββββββ] 100/100
Results:
ββββββββββββββββ¬ββββββββ
β Status β Count β
ββββββββββββββββΌββββββββ€
β Succeeded β 45 β
β Skipped β 55 β
ββββββββββββββββ΄ββββββββ
raps admin user update
Update a userβs role and/or company across multiple projects.
raps admin user update [OPTIONS] <EMAIL>
Arguments:
EMAIL- User email address
Options:
-a, --account <ACCOUNT>- Account ID-r, --role <ROLE>- New role to assign (e.g.,"Project Admin","Document Manager")--company <COMPANY>- Company name to assign at account level--from-role <FROM_ROLE>- Only update users who currently have this role-f, --filter <FILTER>- Filter expression--project-ids <FILE>- File containing project IDs (one per line)--from-csv <FILE>- Import updates from a CSV file (columns: email, role, company)--concurrency <N>- Parallel requests (max: 50)--dry-run- Preview changes without executing--output <FORMAT>- Output format
Example:
$ raps admin user update "user@company.com" --account "acc-123" --role "Document Manager"
Updating user...
[ββββββββββββββββββββββββββββββββββββββββ] 50/50
Results:
ββββββββββββββββ¬ββββββββ
β Status β Count β
ββββββββββββββββΌββββββββ€
β Succeeded β 48 β
β Skipped β 2 β
ββββββββββββββββ΄ββββββββ
raps admin user add-to-all-projects
Add a user to all active projects in an account with an optional role assignment. Unlike user add, this command targets every active project without requiring a filter β useful for onboarding new hires who need access to your entire project portfolio.
raps admin user add-to-all-projects [OPTIONS] <EMAIL>
Arguments:
EMAIL- User email address to add
Options:
-a, --account <ACCOUNT>- Account ID (defaults toAPS_ACCOUNT_IDenv varπEnvironment VariableConfiguration value passed to applications.View in glossary)--role <ROLE>- Role ID to assign in each project (e.g., the project administrator role ID)--concurrency <N>- Parallel requests (max: 50)--dry-run- Preview changes without executing--output <FORMAT>- Output format
Example:
# Add user to all active projects
$ raps admin user add-to-all-projects "new.hire@company.com" --account "acc-123"
# Add with a specific role ID
$ raps admin user add-to-all-projects "new.hire@company.com" \
--account "acc-123" \
--role "your-project-admin-role-id"
# Preview first with dry-run
$ raps admin user add-to-all-projects "new.hire@company.com" --dry-run
Tip: Use
raps acc project-roles list --project <PROJECT_ID>to look up the role IDs available in your account.
raps admin user create
Create (invite) a new user at the account level.
raps admin user create [OPTIONS] <EMAIL>
Arguments:
EMAIL- Email address for the new user
Options:
-a, --account <ACCOUNT>- Account ID (defaults toAPS_ACCOUNT_ID)--first-name <NAME>- Userβs first name--last-name <NAME>- Userβs last name--company <COMPANY>- Company ID to assign--output <FORMAT>- Output format
Example:
$ raps admin user create "jane@company.com" --account "acc-123" \
--first-name Jane --last-name Smith --company "company-uuid"
User created: jane@company.com (user-id: abc-123)
raps admin user get
Get user details by user ID.
raps admin user get [OPTIONS] <USER_ID>
Arguments:
USER_ID- The user ID to look up
Options:
-a, --account <ACCOUNT>- Account ID (defaults toAPS_ACCOUNT_ID)--output <FORMAT>- Output format
Example:
$ raps admin user get "user-abc-123" --account "acc-123"
raps admin user update-account
Update a userβs account-level settings such as company assignment or status.
raps admin user update-account [OPTIONS] <USER_ID_OR_EMAIL>
Arguments:
USER_ID_OR_EMAIL- User ID or email address
Options:
-a, --account <ACCOUNT>- Account ID (defaults toAPS_ACCOUNT_ID)--company <COMPANY>- Company ID to assign--status <STATUS>- Account status (active, inactive)--output <FORMAT>- Output format
Example:
# Assign user to a company
$ raps admin user update-account "jane@company.com" --account "acc-123" \
--company "company-uuid"
# Deactivate a user
$ raps admin user update-account "user-abc-123" --status inactive
raps admin user list
List users in an account or specific project.
raps admin user list [OPTIONS]
Options:
--account, -a- Account ID (defaults to APS_ACCOUNT_ID)--project, -p- List users for a specific project only--role- Filter by role name--status- Filter by status (active, inactive, not_invited)--search- Search by email or name
Example:
$ raps admin user list --account "acc-123" --status active
raps admin user import
Import users to a project from a CSV file.
raps admin user import --project <PROJECT_ID> --from-csv <FILE>
Options:
--project, -p- Project ID to import users into (required)--from-csv- Path to CSV file with columns: email, role_id
Example:
$ raps admin user import --project "proj-123" --from-csv users.csv
Folder Commands
raps admin folder set-permissions
Set folder permissions for a user across multiple projects.
raps admin folder set-permissions [OPTIONS] <EMAIL>
Arguments:
EMAIL- User email address
Options:
-a, --account <ACCOUNT>- Account ID--permission <LEVEL>- Permission level (required)view,view_download,upload,edit,control
--folder <TYPE>- Folder type (required)project_files,plans, or folder URNπURNUnique identifier for objects in APS.View in glossary for custom
-f, --filter <FILTER>- Filter expression--dry-run- Preview changes without executing--output <FORMAT>- Output format
Example:
$ raps admin folder set-permissions "contractor@partner.com" \
--account "acc-123" --permission edit --folder project_files
Updating folder permissions...
[ββββββββββββββββββββββββββββββββββββββββ] 75/75
Results:
ββββββββββββββββ¬ββββββββ
β Status β Count β
ββββββββββββββββΌββββββββ€
β Succeeded β 72 β
β Failed β 3 β
ββββββββββββββββ΄ββββββββ
Company Commands
raps admin company list
List companies registered in an account.
raps admin company list [OPTIONS]
Options:
--account, -a- Account ID (defaults to APS_ACCOUNT_ID)
Example:
$ raps admin company list --account "acc-123"
raps admin company get
Get details for a specific company by ID.
raps admin company get [OPTIONS] <COMPANY_ID>
Arguments:
COMPANY_ID- The company ID to look up
Options:
-a, --account <ACCOUNT>- Account ID (defaults toAPS_ACCOUNT_ID)--output <FORMAT>- Output format
Example:
$ raps admin company get "company-uuid" --account "acc-123"
raps admin company search
Search companies by name.
raps admin company search [OPTIONS] <NAME>
Arguments:
NAME- Company name (or partial name) to search for
Options:
-a, --account <ACCOUNT>- Account ID (defaults toAPS_ACCOUNT_ID)--output <FORMAT>- Output format
Example:
$ raps admin company search "Structural" --account "acc-123"
raps admin company create
Create a new company in an account.
raps admin company create [OPTIONS] <NAME>
Arguments:
NAME- Company name
Options:
-a, --account <ACCOUNT>- Account ID (defaults toAPS_ACCOUNT_ID)--trade <TRADE>- Trade/discipline (e.g., βStructural Engineeringβ)--city <CITY>- City--country <COUNTRY>- Country--output <FORMAT>- Output format
Example:
$ raps admin company create "Structural Design Co" --account "acc-123" \
--trade "Structural Engineering" --city Chicago --country "United States"
Company created: Structural Design Co (id: company-new-uuid)
raps admin company update
Update an existing companyβs details.
raps admin company update [OPTIONS] <COMPANY_ID>
Arguments:
COMPANY_ID- The company ID to update
Options:
-a, --account <ACCOUNT>- Account ID (defaults toAPS_ACCOUNT_ID)--name <NAME>- New company name--trade <TRADE>- New trade/discipline--output <FORMAT>- Output format
Example:
$ raps admin company update "company-uuid" --account "acc-123" \
--name "Structural Design Corp" --trade "Architecture"
Project Commands
raps admin project get
Get details for a specific project by ID.
raps admin project get [OPTIONS] <PROJECT_ID>
Arguments:
PROJECT_ID- The project ID to look up
Options:
-a, --account <ACCOUNT>- Account ID (defaults toAPS_ACCOUNT_ID)--output <FORMAT>- Output format
Example:
$ raps admin project get "b.proj-001" --account "acc-123"
raps admin project list
List projects in an account with optional filtering.
raps admin project list [OPTIONS]
Options:
-a, --account <ACCOUNT>- Account ID-f, --filter <FILTER>- Filter expression--status <STATUS>- Filter by status (active,archived,inactive)--platform <PLATFORM>- Filter by platform (acc,bim360,all)--limit <N>- Limit number of results--output <FORMAT>- Output format
Example:
$ raps admin project list --account "acc-123" --status active --limit 5
Projects:
ββββββββββββββββββββββββββββββββββββββββββ¬ββββββββββββββββββββββββββ¬ββββββββββ¬βββββββββββ
β ID β Name β Status β Platform β
ββββββββββββββββββββββββββββββββββββββββββΌββββββββββββββββββββββββββΌββββββββββΌβββββββββββ€
β b.proj-001 β Downtown Tower β active β ACC β
β b.proj-002 β Hospital Wing β active β ACC β
β b.proj-003 β University Library β active β ACC β
β b.proj-004 β Retail Plaza β active β BIM360 β
β b.proj-005 β Office Complex β active β ACC β
ββββββββββββββββββββββββββββββββββββββββββ΄ββββββββββββββββββββββββββ΄ββββββββββ΄βββββββββββ
raps admin project create
Create a new project in an account.
raps admin project create [OPTIONS]
Options:
--account, -a- Account ID--name, -n- Project name (required)--type, -t- Project type--classification- Project classification (production, template, component, sample)--start-date- Start date (ISO 8601)--end-date- End date (ISO 8601)--timezone- Time zone (e.g., βAmerica/New_Yorkβ)
Example:
$ raps admin project create --account "acc-123" --name "New Hospital Wing" --classification production
raps admin project create-batch
Create multiple projects in parallel with sequential naming.
raps admin project create-batch [OPTIONS] --prefix <PREFIX> --count <COUNT>
Options:
--account, -a- Account ID (defaults toAPS_ACCOUNT_IDenv var)--prefix, -p- Name prefix for projects (e.g., βTest-Projectβ produces βTest-Project-001β, βTest-Project-002β, β¦)--count, -c- Number of projects to create--start- Starting number (default: 1)--concurrency- Max concurrent requests (default: 20)--no-wait- Donβt wait for project activation (fire-and-forget)
Example:
# Create 50 test projects with concurrency 20
$ raps admin project create-batch --account "acc-123" --prefix "Phase2-Building" --count 50
# Start numbering from 100, don't wait for activation
$ raps admin project create-batch --prefix "Wing" --count 10 --start 100 --no-wait
raps admin project update
Update project settings.
raps admin project update [OPTIONS] --project <PROJECT>
Options:
-a, --account <ACCOUNT>- Account ID-p, --project <PROJECT>- Project ID (required)-n, --name <NAME>- New project name--status <STATUS>- New status (active,archived,suspended)--start-date <DATE>- New start date (ISO 8601)--end-date <DATE>- New end date (ISO 8601)
Example:
$ raps admin project update --account "acc-123" --project "proj-123" --status archived
raps admin project archive
Archive a project (shortcut for setting status to archived).
raps admin project archive --account <ACCOUNT_ID> --project <PROJECT_ID>
Example:
$ raps admin project archive --account "acc-123" --project "proj-123"
Operation Commands
raps admin operation status
View the status and progress of an operation.
raps admin operation status [OPTIONS]
Options:
--id <UUID>- Specific operation ID (default: most recent)--output <FORMAT>- Output format
Example:
$ raps admin operation status
Operation: 550e8400-e29b-41d4-a716-446655440000
Type: AddUser
Status: InProgress
Progress:
[ββββββββββββββββββββββββββββββββββββββββ] 50/100
Results so far:
ββββββββββββββββ¬ββββββββ
β Status β Count β
ββββββββββββββββΌββββββββ€
β Succeeded β 45 β
β Skipped β 3 β
β Failed β 2 β
β Pending β 50 β
ββββββββββββββββ΄ββββββββ
raps admin operation resume
Resume an interrupted operation.
raps admin operation resume [OPTIONS]
Options:
--id <UUID>- Operation ID to resume (default: most recent in-progress)
Example:
$ raps admin operation resume
Resuming operation: 550e8400-e29b-41d4-a716-446655440000
Continuing from project 51 of 100...
[ββββββββββββββββββββββββββββββββββββββββ] 100/100
Operation completed successfully!
raps admin operation cancel
Cancel an in-progress operation.
raps admin operation cancel [OPTIONS]
Options:
--id <UUID>- Operation ID to cancel (default: most recent in-progress)
Example:
$ raps admin operation cancel
Cancelling operation: 550e8400-e29b-41d4-a716-446655440000
Operation cancelled. 50 projects were processed before cancellation.
raps admin operation list
List all operations with optional filtering.
raps admin operation list [OPTIONS]
Options:
--status <STATUS>- Filter by status (pending,in_progress,completed,failed,cancelled)--limit <N>- Limit results--output <FORMAT>- Output format
Example:
$ raps admin operation list
Operations:
ββββββββββββββββββββββββββββββββββββββββ¬βββββββββββββ¬ββββββββββββββ¬ββββββββ¬ββββββββββ¬βββββββββ
β ID β Type β Status β Total β Success β Failed β
ββββββββββββββββββββββββββββββββββββββββΌβββββββββββββΌββββββββββββββΌββββββββΌββββββββββΌβββββββββ€
β 550e8400-e29b-41d4-a716-446655440000 β AddUser β Completed β 100 β 95 β 2 β
β 661f9511-f3ac-52e5-b827-557766551111 β RemoveUser β InProgress β 50 β 25 β 0 β
β 772a0622-a4bd-63f6-c938-668877662222 β UpdateRole β Cancelled β 75 β 30 β 1 β
ββββββββββββββββββββββββββββββββββββββββ΄βββββββββββββ΄ββββββββββββββ΄ββββββββ΄ββββββββββ΄βββββββββ
Common Workflows
Onboard New Team Member
# 1. Add to all active projects (simplest approach)
raps admin user add-to-all-projects "new@company.com" \
--account "$ACCOUNT_ID" --dry-run # preview first
raps admin user add-to-all-projects "new@company.com" \
--account "$ACCOUNT_ID"
# 2. Or add to filtered projects with a specific role
raps admin user add "new@company.com" \
--account "$ACCOUNT_ID" \
--role "Project Admin" \
--filter "name:*Active*"
# 3. Grant folder permissions
raps admin folder set-permissions "new@company.com" \
--account "$ACCOUNT_ID" --permission edit --folder project_files
Offboard Departing Employee
# 1. Remove from all projects
raps admin user remove "departed@company.com" --account "$ACCOUNT_ID"
# 2. Verify removal
raps admin operation status
Bulk Role Update
# Update role to "Document Manager" on active 2024 projects
raps admin user update "user@company.com" \
--account "$ACCOUNT_ID" \
--role "Document Manager" \
--filter "name:^2024-"
Exit Codes
| Code | Description |
|---|---|
0 | All operations succeeded |
1 | Partial success (some items failed) |
2 | Operation failed to start |
3 | User cancelled operation |
Next Steps
- Account Admin Cookbook - Detailed recipes and automationπ€AutomationReplacing manual processes with software.View in glossary
- Data Management - Browse hubs and projects
- Authentication - Configure OAuthπOAuthIndustry-standard authorization protocol used by APS.View in glossary