> ## Documentation Index > Fetch the complete documentation index at: https://docs.britive.com/llms.txt > Use this file to discover all available pages before exploring further. # Create a profile ## OpenAPI ````json POST /api/apps/{appContainerId}/paps { "openapi": "3.0.1", "info": { "title": "Britive Services API Documentation", "version": "v1", "description": "API documentation for Users, Tags, Identity providers, Applications, Reporting, Audit logs, Tenants, SSO, Profiles, Password policies, MFA, Access Builder Settings, etc." }, "servers": [ { "url": "https://{tenantURL}", "description": "The primary server", "variables": { "tenantURL": { "default": "test.britive-app.com", "description": "The host of the server" } } } ], "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Access Request Tag Membership", "description": "Manage tag memberships granted via access requests" }, { "name": "API Tokens", "description": "Manage API Tokens" }, { "name": "Application Environments", "description": "Manage Application Environments" }, { "name": "Application Environments - Accounts", "description": "Manage Application Environments Accounts" }, { "name": "Application Profiles", "description": "Manage Application Profiles" }, { "name": "Application Profiles - Advanced Settings", "description": "Manage Application Profiles Advanced Settings" }, { "name": "Application Profiles - Permissions", "description": "Manage Application Profiles Permissions" }, { "name": "Application Profiles - Permission Constraint Manager", "description": "Manage Profile Permission Constraints for the permissions that support to define constraints." }, { "name": "Application Profiles - Policies", "description": "Manage Application Profiles Policies" }, { "name": "Application Profiles - Scopes", "description": "Manage Application Profiles Scopes" }, { "name": "Application Profiles - Session Attributes", "description": "Manage Application Profiles Session Attributes" }, { "name": "Application Profiles - Sessions", "description": "Manage Application Profiles Sessions" }, { "name": "Application Profiles - Users and Tags", "description": "Manage Application Profiles" }, { "name": "Applications", "description": "Manage Applications" }, { "name": "Applications - Access Builder Settings", "description": "Manage access builder settings for an application" }, { "name": "Applications - Advanced Settings", "description": "Manage Applications Advanced Settings" }, { "name": "Applications - Approvers Groups", "description": "Manage approvers groups for association approvers" }, { "name": "Applications - Association Approvers", "description": "Manage association approvers for an application" }, { "name": "Applications - Managed Permissions", "description": "Manage Britive Permissions" }, { "name": "Applications - Permissions", "description": "Manage Application Permissions" }, { "name": "Applications - Root Environment Groups", "description": "Manage Application Root Environment Groups" }, { "name": "Applications - Scans", "description": "Manage Application Scans" }, { "name": "Audit Log Webhooks", "description": "Manage Audit Log Webhooks" }, { "name": "Audit Logs(v1 Deprecated)", "description": "Manage Audit Logs (Deprecated - use Audit Logs v2 instead)" }, { "name": "Audit Logs v2", "description": "Manage Audit Logs v2" }, { "name": "CSPM Integration", "description": "Manage Cloud Security Posture Management (CSPM) tool integrations and their tokens" }, { "name": "CSPM Integration - Findings", "description": "Discover and fetch CSPM finding data, cross-referenced against Britive applications and profiles" }, { "name": "Custom App Template Uploader", "description": "Uploads custom app template." }, { "name": "Custom App Manager", "description": "Creates an app using custom template and other operations for managing the template." }, { "name": "Global Landing Page", "description": "Manage global landing page" }, { "name": "Identity Providers", "description": "Manage identity providers and settings" }, { "name": "IP Restrictions", "description": "Manage firewall rules/settings" }, { "name": "ITSM Connection Metadata", "description": "Manage ITSM Connection Metadata" }, { "name": "ITSM Connections", "description": "Manage ITSM Connections" }, { "name": "ITSM Integration", "description": "Manage ITSM Connections" }, { "name": "IM Connection Metadata", "description": "Manage IM Connection Metadata" }, { "name": "IM Connections", "description": "Manage IM Connections" }, { "name": "IM Integration", "description": "Manage IM Connections" }, { "name": "MCP Access Manager", "description": "Access MCP servers and check out credentials for their tools" }, { "name": "MCP Audit", "description": "Submit MCP gateway audit events" }, { "name": "MCP Server Tools", "description": "Manage the tools exposed by an MCP Server" }, { "name": "MCP Servers", "description": "Manage MCP Servers" }, { "name": "MCP Servers - Policies", "description": "Manage MCP Server Policies" }, { "name": "Multi Factor Authentication", "description": "Manage MFA authentication settings" }, { "name": "My Access", "description": "Manage My Access" }, { "name": "My Devices", "description": "Manage My Devices" }, { "name": "My Resources", "description": "Manage My Resources" }, { "name": "My Resources - Integration", "description": "Manage My Resource Integration" }, { "name": "My Resources - Profiles", "description": "Manage My Resource Profiles" }, { "name": "Notifications", "description": "Manage notifications" }, { "name": "Profile Requests - Managed Permissions", "description": "Manage Profile Requests Britive Permissions" }, { "name": "Reports", "description": "Manage Reports" }, { "name": "Resource Manager", "description": "Manage Resources" }, { "name": "Resource Manager - Broker Pool Management", "description": "Manage remote broker pools, their tokens, labels, and brokers" }, { "name": "Resource Manager - Labels", "description": "Manage Resource Labels" }, { "name": "Resource Manager - Permissions", "description": "Manage Resource Permissions" }, { "name": "Resource Manager - Policies", "description": "Manage Resource Policies" }, { "name": "Resource Manager - Response Templates", "description": "Manage Resource Response Templates" }, { "name": "Resource Manager - Types", "description": "Manage Resource Types" }, { "name": "Resource Profiles", "description": "Manage Resource Profiles" }, { "name": "Resource Profiles - Advanced Settings", "description": "Manage Resource Profiles Advanced Settings" }, { "name": "Resource Profiles - Associations", "description": "Manage Resource Profiles Associations" }, { "name": "Resource Profiles - Permissions", "description": "Manage Resource Profiles Permissions" }, { "name": "Resource Profiles - Policies", "description": "Manage Resource Profiles Policies" }, { "name": "SAML Configuration", "description": "Manage SAML Configuration" }, { "name": "Step Up Authentication", "description": "Manage service identity association to identity provider" }, { "name": "System Announcements", "description": "Manage the system announcements" }, { "name": "Tag Access Request Settings", "description": "Manage access request settings for a user tag" }, { "name": "Tag Access Requests", "description": "Browse tags available for access request" }, { "name": "Task Scheduler", "description": "Manage Tasks" }, { "name": "User Identity Attributes", "description": "Manage User Identity Attributes" }, { "name": "User Resources", "description": "Manage User Built Resources" }, { "name": "User Tags", "description": "Manage User Tags" }, { "name": "Users, Service Identities and AI Identities", "description": "Manage Users, Service Identities and AI Identities" }, { "name": "Workload Identity Providers", "description": "Manage workload identity providers" }, { "name": "Workload SCIM Identity Providers", "description": "Manage service identity association to SCIM provisioning for identity provider" }, { "name": "Workload Service Identity Providers", "description": "Manage service identity association to identity provider" }, { "name": "User Tag Owner", "description": "Tag Owners manage the tag memberships of their owned tags" }, { "name": "Shared Signals - Catalog", "description": "Manage shared signals catalog data" }, { "name": "Shared Signals - Issuers", "description": "Manage shared signals issuers" }, { "name": "Shared Signals - Receivers", "description": "Manage shared signals receivers" }, { "name": "Shared Signals - Results", "description": "Query shared signals processing results" }, { "name": "ThemesManager", "description": "Manage tenant custom theme configurations (public read, admin write)" }, { "name": "BrandingManager", "description": "Manage tenant branding assets — logos, favicon, right-panel image, brand text (saved/applied lifecycle)" } ], "paths": { "/api/apps/{appContainerId}/paps": { "post": { "tags": [ "Application Profiles" ], "summary": "Create a profile", "operationId": "createAppContainerPap", "parameters": [ { "name": "appContainerId", "in": "path", "required": "true", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PapBean" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } } } } }, "components": { "schemas": { "PapBean": { "type": "object", "properties": { "tenantAppId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "inactive", "active" ] }, "expirationDuration": { "type": "integer", "format": "int64" }, "extendable": { "type": "boolean" }, "extensionDuration": { "type": "integer", "format": "int64" }, "extensionLimit": { "type": "integer", "format": "int32" }, "notificationPriorToExpiration": { "type": "integer", "format": "int64" }, "appContainerPapPermissions": { "uniqueItems": "true", "type": "array", "items": { "$ref": "#/components/schemas/AppContainerPapPermission" } }, "runtimeEnvironmentId": { "type": "string" }, "runtimeTargetAccountId": { "type": "integer", "format": "int64" }, "environments": { "type": "array", "items": { "$ref": "#/components/schemas/Environment" } }, "userTagIntegrityChecks": { "type": "array", "items": { "$ref": "#/components/schemas/UserTagIntegrityCheck" } }, "destinationUrl": { "type": "string" }, "origin": { "type": "string" }, "createdBy": { "type": "string" }, "modifiedBy": { "type": "string" }, "lastAccessed": { "type": "string" }, "createdDate": { "type": "string" }, "modifiedDate": { "type": "string" }, "approvalStatus": { "type": "string", "enum": [ "PENDING", "APPROVED", "REJECTED", "TIMEOUT", "WITHDRAWN", "DRAFT", "NO_ACTION_REQUIRED", "CANCELLED" ] }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationPermission" } }, "papId": { "type": "string" }, "appContainerId": { "type": "string" }, "scope": { "type": "array", "items": { "$ref": "#/components/schemas/PapScopeBean" } }, "integrityChecks": { "type": "array", "items": { "$ref": "#/components/schemas/PapPermIntegrityCheckBean" } }, "accountIntegrityChecks": { "type": "array", "items": { "$ref": "#/components/schemas/PapAccountIntegrityCheckBean" } }, "userTags": { "type": "array", "items": { "$ref": "#/components/schemas/PapUserTagBean" } }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/PapUserBean" } }, "policyOrderingEnabled": { "type": "boolean" }, "delegationEnabled": { "type": "boolean" } } }, "AppContainerPapPermission": { "type": "object", "properties": { "name": { "pattern": "^((?!(\\=)|(\\-\\-)).)*$", "type": "string" }, "type": { "pattern": "^((?!(\\=)|(\\-\\-)).)*$", "type": "string" }, "nativeId": { "type": "string" }, "appPermissionId": { "type": "integer", "format": "int64" }, "description": { "type": "string" }, "permissionScopes": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionScope" } }, "privileged": { "type": "boolean" }, "source": { "type": "string" } } }, "Environment": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "type": { "type": "string" }, "parentGroup": { "$ref": "#/components/schemas/EnvironmentGroup" }, "internalParentId": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "nativeId": { "type": "string" }, "nativeGroupParentId": { "type": "string" }, "parentGroupId": { "type": "string" } } }, "UserTagIntegrityCheck": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "userTagId": { "type": "string" }, "status": { "type": "string", "enum": [ "Inactive", "Active" ] }, "accountIntegrityChecks": { "type": "array", "items": { "$ref": "#/components/schemas/PapAccountIntegrityCheck" } } } }, "ApplicationPermission": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "source": { "type": "string" }, "description": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "New", "Unregistered", "Registered", "Updated", "Deleted", "Re-provision" ] }, "modified": { "type": "string", "format": "date-time" }, "permissionScopes": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionScope" } }, "rootPermissionScope": { "$ref": "#/components/schemas/PermissionScope" }, "hasDeletePermissions": { "type": "boolean" }, "extendedAttributes": { "type": "object", "additionalProperties": { "type": "object" } }, "builtIn": { "type": "boolean" }, "permissionDefinition": { "$ref": "#/components/schemas/ApplicationPermissionDefinition" }, "nativeId": { "type": "string" }, "privileged": { "type": "boolean" }, "permissionScopesMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PermissionScope" } }, "tenantAppId": { "type": "integer", "format": "int64" }, "appPermissionId": { "type": "integer", "format": "int64" } } }, "PapScopeBean": { "type": "object", "properties": { "papScopeId": { "type": "integer", "format": "int64" }, "type": { "type": "string", "enum": [ "Environment", "EnvironmentGroup", "ApplicationResource" ] }, "appContainerId": { "type": "integer", "format": "int64" }, "value": { "type": "string" }, "papId": { "type": "string" } } }, "PapPermIntegrityCheckBean": { "type": "object", "properties": { "integrityCheckId": { "type": "integer", "format": "int64" }, "permissionName": { "type": "string" }, "permissionType": { "type": "string" }, "succeeded": { "type": "boolean" }, "environmentId": { "type": "string" }, "scope": { "type": "string" }, "message": { "type": "string" }, "permissionId": { "type": "integer", "format": "int64" }, "appContainerId": { "type": "integer", "format": "int64" }, "tenantAppId": { "type": "integer", "format": "int64" } } }, "PapAccountIntegrityCheckBean": { "type": "object", "properties": { "integrityCheckId": { "type": "integer", "format": "int64" }, "appContainerId": { "type": "integer", "format": "int64" }, "environmentId": { "type": "string" }, "tenantAppId": { "type": "integer", "format": "int64" }, "userId": { "type": "string" }, "nativeUsername": { "type": "string" }, "succeeded": { "type": "boolean" }, "message": { "type": "string" } } }, "PapUserTagBean": { "type": "object", "properties": { "accessPeriod": { "$ref": "#/components/schemas/AccessPeriod" }, "policyId": { "$ref": "#/components/schemas/JsonNode" }, "approvalPoliciesIds": { "$ref": "#/components/schemas/JsonNode" }, "name": { "type": "string" }, "external": { "type": "boolean" }, "description": { "type": "string" }, "userTagId": { "type": "string" }, "status": { "type": "string", "enum": [ "Inactive", "Active" ] }, "userCount": { "type": "integer", "format": "int32" }, "identityProviderId": { "type": "string" }, "membershipRule": { "type": "boolean" } } }, "PapUserBean": { "type": "object", "properties": { "accessPeriod": { "$ref": "#/components/schemas/AccessPeriod" }, "policyId": { "$ref": "#/components/schemas/JsonNode" }, "approvalStatus": { "type": "string", "enum": [ "PENDING", "APPROVED", "REJECTED", "TIMEOUT", "WITHDRAWN", "DRAFT", "NO_ACTION_REQUIRED", "CANCELLED" ] }, "approvalPoliciesIds": { "$ref": "#/components/schemas/JsonNode" }, "mappedAccounts": { "uniqueItems": "true", "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "User", "ServiceIdentity" ] }, "status": { "type": "string", "enum": [ "inactive", "active" ] }, "userId": { "type": "string" }, "email": { "type": "string" }, "username": { "type": "string" } } }, "PermissionScope": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "scopeId": { "type": "integer", "format": "int64" }, "parentId": { "type": "string" }, "nativeId": { "type": "string" } } }, "EnvironmentGroup": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "type": { "type": "string" }, "internalParentId": { "type": "string" }, "parentId": { "type": "string" }, "description": { "type": "string" }, "created": { "$ref": "#/components/schemas/AuditStamp" }, "nativeId": { "type": "string" }, "nativeParentId": { "type": "string" } } }, "PapAccountIntegrityCheck": { "type": "object", "properties": { "message": { "type": "string" }, "appContainerId": { "type": "integer", "format": "int64" }, "papId": { "type": "integer", "format": "int64" }, "userId": { "type": "string" }, "accountId": { "type": "integer", "format": "int64" }, "succeeded": { "type": "boolean" }, "environmentId": { "type": "string" }, "tenantAppId": { "type": "integer", "format": "int64" }, "integrityCheckId": { "type": "integer", "format": "int64" }, "nativeUsername": { "type": "string" } } }, "ApplicationPermissionDefinition": { "type": "object", "properties": { "tags": { "$ref": "#/components/schemas/JsonNode" }, "oldPermissionDefinition": { "$ref": "#/components/schemas/JsonNode" }, "permissionDefinition": { "$ref": "#/components/schemas/JsonNode" }, "appPermissionId": { "type": "integer", "format": "int64" }, "oldTags": { "$ref": "#/components/schemas/JsonNode" } } }, "AccessPeriod": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } }, "JsonNode": { "type": "object" }, "AuditStamp": { "type": "object", "properties": { "user": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "action": { "type": "string" } } } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } } } } ````