flxbl docs
slackGitHub
  • flxbl
  • sfp
  • sfops
  • Overview
  • Getting Started
    • Pre-Requisites
    • Install sfp
    • Configure Your Project
    • Build & Install an Artifact
    • Congratulations!
    • Docker Images
      • sfp-pro
  • CONCEPTS
    • Overview
    • SF CLI vs. SFP
    • Domains
    • Packages
    • Supported package types
      • Unlocked Packages
      • Org-Dependent Unlocked Packages
      • Source Packages
      • Diff Package
      • Data Packages
    • Artifacts
    • Package vs Artifacts
    • Identifying types of a package
    • Dependency management
    • Transitive Dependency Resolution
    • Destructive Changes
  • configuring a project
    • Project structure
    • Setup Salesforce Org
    • Creating a package
    • Defining a domain
    • Release Config
  • BUILDING ARTIFACTS
    • Overview
    • Determining whether an artifact need to be built
    • Building a domain
    • Building an artifact for package individually
    • Limiting artifacts to be built
    • Controlling aspects of the build command
      • Ignoring packages from being built
      • Building a collection of packages together
      • Selective ignoring of components from being built
      • Use of multiple config file in build command
    • Configuring installation behaviour of a package
      • Always deploy a package
      • Skip Install on Certain Orgs
      • Optimized Installation
      • Pre/Post Deployment Script
      • Reconciling Profiles
      • PermissionSet Assignment
      • Updating Picklist
      • Entitlement Deployment Helper
      • Field History & Feed Tracking
      • Aliasfy Packages
        • Aliasfy Packages - Merge Mode
      • State management for Flows
  • Installing an artifact
    • Overview
    • Controlling Aspects of Installation
    • Applying attributes of an artifact
    • BuiltIn Deployment Helpers
      • PermissionSet Group Awaiter
  • publishing and fetching artifacts
    • Publish Artifact
    • Fetching Artifacts
  • Releasing artifacts
    • Overview
    • Release Definitions
    • Generating a release definition
    • Generating a changelog
  • Validating a change
    • Overview
    • Different types of validation
    • Limiting Validation by Domain
    • Controlling validation attributes of a package
      • Skip Testing
      • Skip Coverage Validation
      • Test Synchronously
  • Analysing a Project
    • Overview
    • Duplicate Check
  • Environment Management
    • Pools
      • Scratch Org Pools
        • Defining a pool
        • Setting up your Salesforce Org for Scratch Org Pools
        • Pool Operations
          • Preparing pools
            • Handling dependencies
          • List Scratch Orgs in a pool
          • Fetch a scratch org
          • Delete Pools
      • Sandbox Pools
        • Sandbox Pool Initialization
        • Fetch a Sandbox from Pool
        • Monitor Sandbox Pools
    • Review Environments
      • Commands
        • Fetch a Review Environment
        • Check Review Environment Status
        • Extend a Review Environment
        • Transition Review Environment Status
        • Unassign a Review Environment
      • Considerations
    • Sandbox
      • Create Sandbox
      • Delete Sandbox
      • List Sandbox
      • Login to Sandbox
      • Update Sandbox
  • Development
    • Development Environment
    • Pull Changes from your org
    • Push Changes to your org
    • Dependency Management
      • Expand Dependencies
      • Shrink Dependencies
      • Explain Dependencies
  • Running sfp as a server
    • Introduction
    • sfp-pro-server: Architecture Overview (Alpha)
      • Task Processing System
      • Authentication & Security Architecture
      • Authentication System: Deep Dive
      • Database Architecture
      • Network Architecture and Integration System
      • Integration Architecture: Building Extensions
    • Installing SFP Server
      • Connecting GitHub as a CI/CD provider
    • Initializing SFP server
  • API Reference
    • Health
    • Authentication
    • Token
    • Salesforce
    • Team
    • Users
    • Tasks
    • Key Value
    • Repository
    • WebHooks
  • Metrics
    • Available Metrics
    • Custom Metrics
    • Configuring Collectors
      • Datadog
      • Splunk
      • New Relic
      • StatsD
  • Helpers
    • Managing Shared Resources
  • Command Guide
    • Core
      • Build
      • Quickbuild
      • Publish
      • Install
      • Release
    • Advanced
      • Validate
      • Artifacts
      • Changelog
      • Impact
      • Pool
      • Metrics
      • Repo
    • Utilities
      • Apex Tests
      • Flow
      • Dependency
      • Profile
  • FAQs
    • Common Errors
      • Org Shapes
      • Troubleshooting Unlocked Packages Build Failure Due to Code Coverage
    • Common Questions
      • Email Templates Deployment: Classic vs Lightning
      • Dealing with Long Build Times in Salesforce
      • Standard ValueSets and unlocked packages
      • Common Issues encountered with aliasfied packages
      • API Version
      • Understanding alwaysDeploy and skipIfAlreadyInstalled in Deployment Pipelines
    • sfp versioning and upgrade Process
  • References
  • Legal
    • Terms of Service for sfp
    • Terms of Service for 'sfp-pro' Software
  • LLMs.txt
Powered by GitBook
On this page
  1. API Reference

Users

Last updated 1 month ago

List users in a team

get

Retrieves a paginated list of users. Can filter by: - Specific team (using team slug) - User role (owner, member, application) - No team filter returns users across all teams the requester has access to

    Returns user details including email, role, team memberships, and timestamps. Pagination is supported via limit and offset parameters. Only users with owner role can list users.
Authorizations
Query parameters
teamstringOptional

Team identifier (slug) to filter users by

Example: engineering
limitnumberOptional

Number of records to return

Example: 10
offsetnumberOptional

Number of records to skip

Example: 0
rolestring · enumOptional

Filter by role

Possible values:
Responses
200
List of users retrieved successfully
application/json
400
Bad request
401
Unauthorized
get
GET /sfp/api/users HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
{
  "users": [
    {
      "id": "text",
      "firstName": "text",
      "lastName": "text",
      "email": "text",
      "role": "owner",
      "teams": [
        "text"
      ],
      "authData": {}
    }
  ],
  "total": 1
}

Get current user profile

get

Retrieves the complete profile of the currently authenticated user. Returns: - User identification (ID, email) - Account details and role - Team memberships - Authentication metadata (first name, last name) - JWT token information if available

    This endpoint is useful for applications to understand the current user's permissions and profile after authentication.
Authorizations
Responses
200
User profile retrieved successfully
application/json
401
Unauthorized
get
GET /sfp/api/users/me HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
{
  "id": "text",
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "role": "owner",
  "teams": [
    "text"
  ],
  "authData": {}
}
  • GETGet user by email
  • PUTUpdate user details
  • GETList users in a team
  • GETGet current user profile
  • DELETEDelete a user from a team
  • POSTCreate a new user in a team

Get user by email

get

Retrieves detailed information about a specific user by their email address.

    Access control:
    - Self-lookup: Users can always retrieve their own full profile
    - Owner lookup: Owners can view other users but receive limited data (no sensitive auth metadata)
    - Team-specific lookup: Optionally filter by team using the team slug parameter
    
    Returns user profile including account details, team memberships, and appropriate metadata based on access level.
Authorizations
Path parameters
emailstringRequired

User email

Query parameters
teamstringOptional

Team slug (optional for self-lookups)

Responses
200
User profile retrieved successfully
application/json
400
Bad request
401
Unauthorized
404
User not found
get
GET /sfp/api/users/{email} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
{
  "id": "text",
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "role": "owner",
  "teams": [
    "text"
  ],
  "authData": {}
}

Update user details

put

Updates user profile information. Users can update: - Their own profile (self-update) - Other users' profiles if they have owner role

    Updatable fields include:
    - User metadata (first name, last name)
    - Role assignments within teams
    - Team associations
    
    The endpoint validates permissions and ensures users cannot escalate their own privileges. Returns the updated user profile on success.
Authorizations
Path parameters
emailstringRequired

User email

Query parameters
teamstringOptional

Team slug (optional)

Body
firstNamestringOptional

First name of the user

Example: John
lastNamestringOptional

Last name of the user

Example: Doe
rolestring · enumOptional

Role of the user in the team

Possible values:
Responses
200
User updated successfully
application/json
400
Bad request
401
Unauthorized
404
User not found
put
PUT /sfp/api/users/{email} HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "firstName": "John",
  "lastName": "Doe",
  "role": "owner"
}
{
  "success": true,
  "user": {
    "id": "text",
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "role": "owner",
    "teams": [
      "text"
    ],
    "authData": {}
  },
  "error": "text"
}

Delete a user from a team

delete

Removes a user from a team or from all teams. This endpoint: - Removes the user's team membership(s) - Revokes access to team resources - Optionally removes from all teams if no team is specified - Does not delete the user account itself (user can still log in but won't have team access)

    Only users with owner role can delete users. Users cannot delete themselves. If removing from all teams, the user effectively loses all access to the system.
Authorizations
Body
emailstringRequired

Email address of the user to remove

Example: john.doe@example.com
teamstringOptional

Team identifier (slug) to remove the user from. If not provided, user will be removed from all teams.

Example: engineering
Responses
200
User deleted successfully
application/json
400
Bad request
application/json
401
Unauthorized
application/json
delete
DELETE /sfp/api/users HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "email": "john.doe@example.com",
  "team": "engineering"
}
{
  "success": true,
  "email": "text",
  "team": "text",
  "userId": "text",
  "teamAccountId": "text",
  "error": "text"
}

Create a new user in a team

post

Creates a new user account and adds them to the specified team. This endpoint: - Creates the user in the authentication system - Assigns the specified role (owner, member, or application) - Associates the user with the team - Sends a welcome email with login instructions

    Only users with owner role can create new users. The email must be unique across the system. If the user already exists in another team, they will be added to the specified team with the given role.
Authorizations
Body
firstNamestringRequired

First name of the user

Example: John
lastNamestringRequired

Last name of the user

Example: Doe
emailstringRequired

Email address of the user

Example: john.doe@example.com
teamstringRequired

Team identifier (slug) to add the user to

Example: engineering
rolestring · enumRequired

Role of the user in the team

Default: memberPossible values:
Responses
201
User created successfully
application/json
400
Bad request
application/json
401
Unauthorized
application/json
post
POST /sfp/api/users HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "team": "engineering",
  "role": "member"
}
{
  "success": true,
  "userId": "text",
  "teamAccountId": "text",
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "team": "text",
  "role": "owner",
  "isExistingUser": true,
  "error": "text"
}