> ## 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. # Get all profiles associated with the user with an API token ## OpenAPI ````json GET /api/access { "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": "Global Session Settings", "description": "Manage tenant-wide session and token lifetimes" }, { "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 - Rotation Templates", "description": "Manage rotation templates for resource types" }, { "name": "Resource Manager - Types", "description": "Manage Resource Types" }, { "name": "Resource Manager - Verification Templates", "description": "Manage verification templates for 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": "Temporary Tokens", "description": "Issue short-lived tokens carrying the caller's own permissions" }, { "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/access": { "get": { "tags": [ "My Access" ], "summary": "Get all profiles associated with the user with an API token", "operationId": "getMyAccess", "parameters": [ { "name": "page", "in": "query", "description": "page number of my-access profile list. Default is 0", "required": "false", "schema": { "type": "integer", "format": "int32", "default": "0" } }, { "name": "size", "in": "query", "description": "size of the request for my-access profile list. Default is 20.", "required": "false", "schema": { "type": "integer", "format": "int32", "default": "20" } }, { "name": "filter", "in": "query", "description": "Filters for my-access profiles that can be applied - appName, papName, environmentName, environmentId, appType. Operators - eq, sw, co", "required": "false", "schema": { "type": "string" }, "example": "appName eq \"AWS\"" }, { "name": "sort", "in": "query", "description": "Sorting of my-access profiles that can be applied - appName, papName, environmentName, environmentId, appType. Operators - asc, desc", "required": "false", "schema": { "type": "string" }, "example": "appName,ASC" }, { "name": "searchText", "in": "query", "description": "Search by all fields.", "required": "false", "schema": { "type": "string" }, "example": "searchText=AWS" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MyAccessSummary" } } } } } } } }, "components": { "schemas": { "MyAccessSummary": { "type": "object", "properties": { "count": { "type": "integer", "description": "Total count of items", "example": "100" }, "page": { "type": "integer", "description": "Current page number", "example": "0" }, "size": { "type": "integer", "description": "Page size", "example": "20" }, "sort": { "type": "string", "description": "Sort order", "example": "appName,ASC" }, "filter": { "type": "string", "nullable": "true", "description": "Applied filter", "example": "appName eq \"AWS\"" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MyAccess" } } } }, "MyAccess": { "type": "object", "properties": { "frequency": { "type": "integer", "example": "0" }, "countOfProfiles": { "type": "integer", "example": "100" }, "papId": { "type": "string", "example": "id1" }, "environmentId": { "type": "string", "example": "envId1" }, "appId": { "type": "string", "example": "appId1" }, "myAccessDetails": { "type": "array", "items": { "$ref": "#/components/schemas/MyAccessDetail" } }, "application": { "$ref": "#/components/schemas/MyAccessApplication" }, "environment": { "$ref": "#/components/schemas/MyAccessEnvironment" }, "profile": { "$ref": "#/components/schemas/MyAccessProfile" } } }, "MyAccessDetail": { "type": "object", "properties": { "checkOutTime": { "type": "string", "format": "date-time", "nullable": "true" }, "checkInTime": { "type": "string", "format": "date-time", "nullable": "true" }, "status": { "type": "string", "enum": [ "Allow", "Deny", "Pending" ], "example": "Allow" }, "approvalValidityTime": { "type": "string", "format": "date-time", "nullable": "true" }, "accessType": { "type": "string", "enum": [ "CONSOLE", "PROGRAMMATIC" ], "example": "CONSOLE" }, "favoriteId": { "type": "string", "nullable": "true" } } }, "MyAccessApplication": { "type": "object", "properties": { "appId": { "type": "string", "example": "appId1" }, "appName": { "type": "string", "example": "AWS" }, "applicationType": { "type": "string", "example": "AWS" }, "consoleAccessError": { "type": "string", "nullable": "true" }, "programmaticAccessError": { "type": "string", "nullable": "true" }, "description": { "type": "string", "nullable": "true" }, "supportsToken": { "type": "boolean", "example": "false" }, "showAwsAccountNumber": { "type": "boolean", "example": "false" }, "supportsMultipleProfilesCheckoutCli": { "type": "boolean", "example": "false" }, "supportsMultipleProfilesCheckoutConsole": { "type": "boolean", "example": "false" }, "allowCopyingConsoleUrl": { "type": "boolean", "example": "false" }, "displayProgrammaticKeys": { "type": "boolean", "example": "true" }, "requiresHierarchicalModel": { "type": "boolean", "example": "false" }, "consoleAccess": { "type": "boolean", "example": "true" }, "programmaticAccess": { "type": "boolean", "example": "false" }, "supportsSharedAccounts": { "type": "boolean", "example": "true" } } }, "MyAccessEnvironment": { "type": "object", "properties": { "environmentId": { "type": "string", "example": "envId1" }, "environmentName": { "type": "string", "example": "demo" }, "environmentDescription": { "type": "string", "example": "" }, "alternateEnvironmentName": { "type": "string", "example": "demo" }, "accountId": { "type": "string", "nullable": "true" }, "profileEnvironmentProperties": { "type": "object", "additionalProperties": "true", "example": {} } } }, "MyAccessProfile": { "type": "object", "properties": { "papId": { "type": "string", "example": "id1" }, "papName": { "type": "string", "example": "S3Access" }, "description": { "type": "string", "example": "" }, "consoleAccess": { "type": "boolean", "example": "true" }, "programmaticAccess": { "type": "boolean", "example": "false" }, "sessionAttributes": { "type": "array", "items": { "type": "object" }, "example": [] }, "accessCount": { "type": "integer", "example": "0" }, "expirationDuration": { "type": "integer", "format": "int64", "description": "Duration in milliseconds", "example": "1800000" }, "extensionDuration": { "type": "integer", "format": "int64", "description": "Duration in milliseconds", "example": "1800000" }, "extensionLimit": { "type": "integer", "example": "1" }, "notificationPriorToExpiration": { "type": "integer", "format": "int64", "description": "Duration in milliseconds", "example": "300000" }, "extendable": { "type": "boolean", "example": "false" } } } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } } } } ````