Favicon

You are here: Home > API Reference > Workspace > User Authentication > SSO Callback

SSO Callback

SSO Callback

POST
/v1/auth/sso/:organizationSlug/:type/callback
Copy to clipboard

SSO Callback

SSO Callback

Request

Add parameter in header authorization
Example: Authorization: Bearer <token>
organizationSlug string
required
≤ 128 characters
type string
required
ldapsaml
{
  "type": "object",
  "properties": {}
}

Responses

200 Response application/json
status boolean optional
data object optional
accessToken object optional
token string optional
≤ 128 characters
expireAt string optional
Format: date-time
refreshToken object optional
token string optional
≤ 128 characters
expireAt string optional
Format: date-time
user object optional
id string optional
Unique identifier for the user account within the platform, used to reference this specific user across all authentication, authorization, and audit logging throughout the system.
Match pattern: ^[a-fA-F0-9]{24}$
email string optional
Primary email address associated with the user account, used for authentication, notifications, password recovery, and all official communication from the platform to the user.
≤ 256 characters · Format: email
firstName string optional
User's given name or first name as provided during registration or profile updates, displayed in dashboards, and used for personalization throughout the user interface and email communications.
≤ 128 characters
lastName string optional
User's family name or surname as provided during registration or profile updates, used for display purposes in team lists and collaboration interfaces.
≤ 128 characters
fullName string optional
Computed concatenation of first and last names for convenient display in user interfaces, notifications, and reports without requiring separate name field handling in frontend applications.
≤ 128 characters
picture string optional
URL or path to the user's profile picture or avatar image, displayed in navigation menus, team listings, and collaboration interfaces to provide visual identification across the platform.
role string optional
Global platform role assigned to this user determining their system-wide permissions and access level, such as platform administrator, organization owner, or standard user with varying capabilities.
admin adminViewer user serviceAccount
newsletter boolean optional
Flag indicating whether the user has opted in to receive newsletter emails, product updates, feature announcements, and marketing communications from the platform according to their communication preferences.
hasPassword boolean optional
Indicates whether the user has set a password for traditional email and password authentication, as opposed to relying solely on single sign-on or social authentication providers.
has2FAActive boolean optional
Flag indicating whether two-factor authentication is currently enabled for this user account, providing an additional security layer beyond password authentication to protect against unauthorized access.
ssoUser boolean optional
Indicates whether this user account was created through single sign-on integration with external identity providers like SAML, OAuth, or enterprise directory services rather than traditional registration.
organizationId string optional
Currently selected organization identifier for user, determining which workspace resources and applications are accessible.
Match pattern: ^[a-fA-F0-9]{24}$
organizations array [object] optional
Array of all organizations that this user is a member of with any role, enabling organization switching in the dashboard and determining the complete scope of accessible resources.
id string optional
Unique identifier of an organization that this user is a member of, allowing access to that organization's applications, builds, and device management resources.
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
Human-readable name of the organization as displayed in organization switcher menus and navigation interfaces, helping users identify and switch between multiple organizations they belong to.
≤ 128 characters
slug string optional
URL-friendly identifier for the organization used in dashboard URLs and API endpoints, providing a readable and shareable way to reference organizations in web interfaces.
≤ 128 characters
picture string optional
URL or path to the organization's logo or brand image, displayed in organization switcher interfaces and navigation headers to provide visual identification.
organizationInfo object optional
Detailed information about the currently active organization providing full context for the user session including branding, store configuration, and administrative settings.
id string optional
Unique identifier of the currently active organization providing context for all user operations, application access, and resource visibility in the current session.
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
Human-readable name of the currently active organization displayed in the dashboard header and used throughout the interface to provide context awareness.
≤ 128 characters
slug string optional
URL-friendly identifier of the currently active organization used in browser URLs and shareable links to maintain organization context across navigation.
≤ 128 characters
picture string optional
URL or path to the currently active organization's logo displayed in the dashboard navigation header for branding and context awareness.
createdBy string optional
Identifier of the user who originally created this organization, providing audit information, and establishing the original organization owner for accountability and administrative purposes.
Match pattern: ^[a-fA-F0-9]{24}$
branding object optional
Customization settings for organization-specific visual branding including colors, logos, and styling preferences applied to user-facing distribution portals and download pages.
store object optional
Configuration settings for the organization's self-service app store portal where end users can browse and download available applications assigned to their distribution groups.
configuration object optional
Advanced organization-wide configuration parameters including storage providers, security policies, retention settings, and integration credentials that apply across all applications within the organization.
language string optional
Preferred interface language code for the user determining the language used for dashboard labels, buttons, notifications, and all user-facing content supporting internationalization across the platform.
es en fr de it zh pt ru
verificationStatus string optional
Current email verification status of the user account indicating whether the user has confirmed ownership of their email address through the verification link sent during registration.
verified unverified unknown
activityTrace object optional
Activity tracking information capturing recent user actions, session history, and interaction timestamps for security monitoring and behavioral analytics.
lastLogin object optional
dashboard string optional
Format: date-time
sdk string optional
Format: date-time
store string optional
Format: date-time
lastAction object optional
dashboard string optional
Format: date-time
sdk string optional
Format: date-time
store string optional
Format: date-time
intercomUserHash string optional
Secure hash used for identity verification when launching Intercom chat widget, ensuring that support conversations are authenticated and associated with the correct user account for privacy and security.
≤ 128 characters
createdAt string optional
ISO 8601 timestamp of user account creation recording when account registered for tracking account age and tenure analysis.
Format: date-time
updatedAt string optional
ISO 8601 timestamp of most recent modification indicating last update to user profile, password, preferences, or role assignments.
Format: date-time
{
    "status": true,
    "data": {
        "accessToken": {
            "token": "string",
            "expireAt": "2024-01-01T00: 00:00Z"
        },
        "refreshToken": {
            "token": "string",
            "expireAt": "2024-01-01T00: 00:00Z"
        },
        "user": {
            "id": "507f1f77bcf86cd799439023",
            "email": "[email protected]",
            "firstName": "John",
            "lastName": "Doe",
            "fullName": "John Doe",
            "picture": "https://example.com/images/profile-picture.jpg",
            "role": "user",
            "newsletter": true,
            "hasPassword": true,
            "has2FAActive": false,
            "ssoUser": false,
            "organizationId": "507f1f77bcf86cd799439024",
            "organizations": [
                {
                    "id": "507f1f77bcf86cd799439025",
                    "name": "Enterprise Corporation",
                    "slug": "enterprise-corp",
                    "picture": "https://cdn.applivery.com/orgs/507f1f77bcf86cd799439025/logo.png"
                }
            ],
            "organizationInfo": {
                "id": "507f1f77bcf86cd799439026",
                "name": "Acme Industries",
                "slug": "acme-industries",
                "picture": "https://cdn.applivery.com/orgs/507f1f77bcf86cd799439026/logo.png",
                "createdBy": "507f1f77bcf86cd799439027",
                "branding": {
                    "primaryColor": "#0066CC",
                    "logoUrl": "https://cdn.example.com/logo.png"
                },
                "store": {
                    "enabled": true,
                    "customDomain": "apps.acme.com"
                },
                "configuration": {
                    "defaultStorageProvider": "507f1f77bcf86cd799439028",
                    "enforceSSO": true
                }
            },
            "language": "en",
            "verificationStatus": "verified",
            "activityTrace": {
                "lastLogin": {
                    "dashboard": "2024-01-01T00: 00:00Z",
                    "sdk": "2024-01-01T00: 00:00Z",
                    "store": "2024-01-01T00: 00:00Z"
                },
                "lastAction": {
                    "dashboard": "2024-01-01T00: 00:00Z",
                    "sdk": "2024-01-01T00: 00:00Z",
                    "store": "2024-01-01T00: 00:00Z"
                }
            },
            "intercomUserHash": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
            "createdAt": "2025-06-15T10: 00:00Z",
            "updatedAt": "2026-02-03T15: 30:00Z"
        }
    }
}
400 Response application/json
status boolean optional
false
error object optional
code number optional
5070
message string optional
Saml get profile error
{
    "status": false,
    "error": {
        "code": 5070,
        "message": "Saml get profile error"
    }
}