FINBOURNE Identity Service API
Project description
Documentation for API Endpoints
All URIs are relative to https://fbn-prd.lusid.com/identity
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ApplicationMetadataApi | list_access_controlled_resources | GET /api/metadata/access/resources | ListAccessControlledResources: Get resources available for access control |
| ApplicationsApi | create_application | POST /api/applications | [EARLY ACCESS] CreateApplication: Create Application |
| ApplicationsApi | delete_application | DELETE /api/applications/{id} | [EARLY ACCESS] DeleteApplication: Delete Application |
| ApplicationsApi | get_application | GET /api/applications/{id} | GetApplication: Get Application |
| ApplicationsApi | list_applications | GET /api/applications | ListApplications: List Applications |
| ApplicationsApi | rotate_application_secrets | POST /api/applications/{id}/lifecycle/$newsecret | [EARLY ACCESS] RotateApplicationSecrets: Rotate Application Secrets |
| AuthenticationApi | get_authentication_information | GET /api/authentication/information | GetAuthenticationInformation: Gets AuthenticationInformation |
| AuthenticationApi | get_password_policy | GET /api/authentication/password-policy/{userType} | GetPasswordPolicy: Gets password policy for a user type |
| AuthenticationApi | get_session_policy | GET /api/authentication/session-policy | [EXPERIMENTAL] GetSessionPolicy: Get session policy |
| AuthenticationApi | get_support_access_history | GET /api/authentication/support | GetSupportAccessHistory: Get the history of all support access granted and any information pertaining to their termination |
| AuthenticationApi | get_support_roles | GET /api/authentication/support-roles | GetSupportRoles: Get mapping of support roles, the internal representation to a human friendly representation |
| AuthenticationApi | grant_support_access | POST /api/authentication/support | GrantSupportAccess: Grants FINBOURNE support access to your account |
| AuthenticationApi | invalidate_support_access | DELETE /api/authentication/support | InvalidateSupportAccess: Revoke any FINBOURNE support access to your account |
| AuthenticationApi | update_password_policy | PUT /api/authentication/password-policy/{userType} | UpdatePasswordPolicy: Updates password policy for a user type |
| AuthenticationApi | update_session_policy | PUT /api/authentication/session-policy | [EXPERIMENTAL] UpdateSessionPolicy: Update session policy |
| CellManagementApi | accept_cell_attachment | POST /api/cellmanagement/acceptattachment | [EARLY ACCESS] AcceptCellAttachment: Accept (or retry) a cell attachment |
| CellManagementApi | detach_parent_cell | PUT /api/cellmanagement/detach | [EARLY ACCESS] DetachParentCell: Detach this cell from its parent |
| CellManagementApi | get_cell_parent_status | GET /api/cellmanagement/parentcell | [EARLY ACCESS] GetCellParentStatus: Get cell parent status |
| CellManagementApi | refuse_cell_attachment | POST /api/cellmanagement/refuseattachment | [EARLY ACCESS] RefuseCellAttachment: Refuse a Proposed cell attachment |
| CellManagementApi | remove_primary_domain | DELETE /api/cellmanagement/primarydomain | [EARLY ACCESS] RemovePrimaryDomain: Remove primary domain |
| CellManagementApi | rotate_attaching_key | PUT /api/cellmanagement/attachingkey/rotate | [EARLY ACCESS] RotateAttachingKey: Rotate the stored Attaching Key on an Attached cell |
| CellManagementApi | rotate_domain_keys | POST /api/cellmanagement/rotatedomainkeys | [EARLY ACCESS] RotateDomainKeys: Force a sweep-rotation of every parent-cell service-user PAT on this cell |
| CellManagementApi | set_attaching_key | PUT /api/cellmanagement/attachingkey | [EARLY ACCESS] SetAttachingKey: Store the Attaching Key pasted from the parent admin portal |
| CellManagementApi | set_parent_cell | PUT /api/cellmanagement/parentcell | [EARLY ACCESS] SetParentCell: Set parent cell |
| CellManagementApi | set_primary_domain | PUT /api/cellmanagement/primarydomain | [EARLY ACCESS] SetPrimaryDomain: Set primary domain |
| ExternalTokenIssuersApi | create_external_token_issuer | POST /api/externaltokenissuers | [EARLY ACCESS] CreateExternalTokenIssuer: Create an External Token Issuer |
| ExternalTokenIssuersApi | delete_external_token_issuer | DELETE /api/externaltokenissuers/{code} | [EARLY ACCESS] DeleteExternalTokenIssuer: Deletes an External Token Issuer by code |
| ExternalTokenIssuersApi | get_external_token_issuer | GET /api/externaltokenissuers/{code} | [EARLY ACCESS] GetExternalTokenIssuer: Gets an External Token Issuer with code |
| ExternalTokenIssuersApi | list_external_token_issuers | GET /api/externaltokenissuers | [EARLY ACCESS] ListExternalTokenIssuers: Lists all External Token Issuers for a domain |
| ExternalTokenIssuersApi | update_external_token_issuer | PUT /api/externaltokenissuers/{code} | [EARLY ACCESS] UpdateExternalTokenIssuer: Updates an existing External Token Issuer |
| IdentityLogsApi | list_logs | GET /api/logs | [BETA] ListLogs: Lists system logs for a domain |
| IdentityLogsApi | list_user_logs | GET /api/logs/me | ListUserLogs: Lists user logs |
| IdentityProviderApi | add_scim | PUT /api/identityprovider/scim | AddScim: Add SCIM |
| IdentityProviderApi | remove_scim | DELETE /api/identityprovider/scim | RemoveScim: Remove SCIM |
| MCPToolsApi | create_mcp_tool | POST /api/mcptools/{scope}/{code} | [EARLY ACCESS] CreateMcpTool: Create an MCP Tool |
| MCPToolsApi | delete_mcp_tool | DELETE /api/mcptools/{scope}/{code} | [EARLY ACCESS] DeleteMcpTool: Delete an MCP Tool |
| MCPToolsApi | get_mcp_tool | GET /api/mcptools/{scope}/{code} | [EARLY ACCESS] GetMcpTool: Get an MCP Tool |
| MCPToolsApi | list_mcp_tools | GET /api/mcptools | [EARLY ACCESS] ListMcpTools: List all MCP Tools |
| MCPToolsApi | update_mcp_tool | PUT /api/mcptools/{scope}/{code} | [EARLY ACCESS] UpdateMcpTool: Update an MCP Tool |
| MeApi | get_user_info | GET /api/me | GetUserInfo: Get User Info |
| MeApi | set_password | PUT /api/me/password | SetPassword: Set password of current user |
| NetworkZonesApi | create_network_zone | POST /api/networkzones | [EARLY ACCESS] CreateNetworkZone: Creates a network zone |
| NetworkZonesApi | delete_network_zone | DELETE /api/networkzones/{code} | [EARLY ACCESS] DeleteNetworkZone: Deletes a network zone |
| NetworkZonesApi | get_network_zone | GET /api/networkzones/{code} | [EARLY ACCESS] GetNetworkZone: Retrieve a Network Zone |
| NetworkZonesApi | list_network_zones | GET /api/networkzones | [EARLY ACCESS] ListNetworkZones: Lists all network zones for a domain |
| NetworkZonesApi | update_network_zone | PUT /api/networkzones/{code} | [EARLY ACCESS] UpdateNetworkZone: Updates an existing network zone |
| PersonalAuthenticationTokensApi | create_api_key | POST /api/keys | CreateApiKey: Create a Personal Access Token |
| PersonalAuthenticationTokensApi | delete_api_key | DELETE /api/keys/{id} | DeleteApiKey: Invalidate a Personal Access Token |
| PersonalAuthenticationTokensApi | list_own_api_keys | GET /api/keys | ListOwnApiKeys: Gets the meta data for all of the user's existing Personal Access Tokens. |
| RolesApi | add_user_to_role | PUT /api/roles/{id}/users/{userId} | AddUserToRole: Add User to Role |
| RolesApi | create_role | POST /api/roles | CreateRole: Create Role |
| RolesApi | delete_role | DELETE /api/roles/{id} | DeleteRole: Delete Role |
| RolesApi | get_role | GET /api/roles/{id} | GetRole: Get Role |
| RolesApi | get_role_by_code | GET /api/roles/byCode/{code} | GetRoleByCode: Get Role By Code |
| RolesApi | list_roles | GET /api/roles | ListRoles: List Roles |
| RolesApi | list_users_in_role | GET /api/roles/{id}/users | ListUsersInRole: Get the users in the specified role. |
| RolesApi | remove_user_from_role | DELETE /api/roles/{id}/users/{userId} | RemoveUserFromRole: Remove User from Role |
| RolesApi | update_role | PUT /api/roles/{id} | UpdateRole: Update Role |
| TokensApi | invalidate_token | DELETE /api/tokens | InvalidateToken: Invalidate current JWT token (sign out) |
| UsersApi | create_user | POST /api/users | CreateUser: Create User |
| UsersApi | delete_user | DELETE /api/users/{id} | DeleteUser: Delete User |
| UsersApi | expire_password | POST /api/users/{id}/lifecycle/$expirepassword | ExpirePassword: Reset the user's password to a temporary one |
| UsersApi | find_users_by_id | GET /api/directory | FindUsersById: Find users by id endpoint |
| UsersApi | get_user | GET /api/users/{id} | GetUser: Get User |
| UsersApi | get_user_from_login | GET /api/users/fromlogin/{login} | GetUserFromLogin: Get User From Login |
| UsersApi | get_user_schema | GET /api/users/schema | [EARLY ACCESS] GetUserSchema: Get User Schema |
| UsersApi | list_runnable_users | GET /api/users/$runnable | [EARLY ACCESS] ListRunnableUsers: List Runable Users |
| UsersApi | list_users | GET /api/users | ListUsers: List Users |
| UsersApi | reset_factors | POST /api/users/{id}/lifecycle/$resetfactors | ResetFactors: Reset MFA factors |
| UsersApi | reset_password | POST /api/users/{id}/lifecycle/$resetpassword | ResetPassword: Reset Password |
| UsersApi | send_activation_email | POST /api/users/{id}/lifecycle/$activate | SendActivationEmail: Sends an activation email to the User |
| UsersApi | unlock_user | POST /api/users/{id}/lifecycle/$unlock | UnlockUser: Unlock User |
| UsersApi | unsuspend_user | POST /api/users/{id}/lifecycle/$unsuspend | [EXPERIMENTAL] UnsuspendUser: Unsuspend user |
| UsersApi | update_user | PUT /api/users/{id} | UpdateUser: Update User |
| UsersApi | update_user_schema | PUT /api/users/schema | [EARLY ACCESS] UpdateUserSchema: Update User Schema |
Documentation for Models
- AccessControlledAction
- AccessControlledResource
- ActionId
- AddScimResponse
- ApiKey
- AuthenticationInformation
- CellParentStatusResponse
- ClaimMappings
- CreateApiKey
- CreateApplicationRequest
- CreateExternalTokenIssuerRequest
- CreateNetworkZoneRequest
- CreateRoleRequest
- CreateUserRequest
- CreatedApiKey
- CurrentUserResponse
- DetachParentCellRequest
- ErrorDetail
- ExternalTokenIssuerResponse
- IdSelectorDefinition
- IdentifierPartSchema
- IpAddressDefinition
- Link
- ListUsersResponse
- LogActor
- LogAuthenticationContext
- LogClientInfo
- LogDebugContext
- LogGeographicalContext
- LogGeolocation
- LogIpChainEntry
- LogIssuer
- LogOutcome
- LogRequest
- LogSecurityContext
- LogSeverity
- LogTarget
- LogTransaction
- LogUserAgent
- LusidProblemDetails
- LusidValidationProblemDetails
- McpToolLuminescePayload
- McpToolParameter
- McpToolResponse
- McpToolSchedulerNotification
- McpToolSchedulerPayload
- NetworkZoneDefinitionResponse
- NetworkZonesApplyRules
- OAuthApplication
- PasswordPolicyResponse
- PasswordPolicyResponseAge
- PasswordPolicyResponseComplexity
- PasswordPolicyResponseConditions
- PasswordPolicyResponseLockout
- ResourceListOfAccessControlledResource
- ResourceListOfSystemLog
- RoleId
- RoleResponse
- RotateAttachingKeyRequest
- SessionPolicyResponse
- SetAttachingKeyRequest
- SetParentCellRequest
- SetPassword
- SetPasswordResponse
- SupportAccessExpiry
- SupportAccessExpiryWithRole
- SupportAccessRequest
- SupportAccessResponse
- SupportRole
- SupportRolesResponse
- SystemLog
- TemporaryPassword
- UpdateExternalTokenIssuerRequest
- UpdateNetworkZoneRequest
- UpdatePasswordPolicyRequest
- UpdatePasswordPolicyRequestAge
- UpdatePasswordPolicyRequestComplexity
- UpdatePasswordPolicyRequestConditions
- UpdatePasswordPolicyRequestLockout
- UpdateRoleRequest
- UpdateSessionPolicyRequest
- UpdateUserRequest
- UpdateUserSchemaRequest
- UpsertMcpToolRequest
- UserResponse
- UserSchemaProperty
- UserSchemaResponse
- UserSummary
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
finbourne_identity_sdk-2.3.13.tar.gz
(100.0 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file finbourne_identity_sdk-2.3.13.tar.gz.
File metadata
- Download URL: finbourne_identity_sdk-2.3.13.tar.gz
- Upload date:
- Size: 100.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.4.1 CPython/3.11.9 Linux/6.12.54-flatcar
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
491f6599f6a348e16def8db068019a1a30825bbb996bb5dee0c8194bca8d7125
|
|
| MD5 |
3063ddca5554956bacc24c80432023a4
|
|
| BLAKE2b-256 |
f1a34eec15a89e6169cfb7879d1803ea9e6535e9b4f82abc0fc55120caca3f30
|
File details
Details for the file finbourne_identity_sdk-2.3.13-py3-none-any.whl.
File metadata
- Download URL: finbourne_identity_sdk-2.3.13-py3-none-any.whl
- Upload date:
- Size: 231.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.4.1 CPython/3.11.9 Linux/6.12.54-flatcar
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5f575413e5eeb733676cdf8d33afec975d944fbdd138883f7c865cc5318d47d9
|
|
| MD5 |
8e05188993f5b8e772c39864da36ee5a
|
|
| BLAKE2b-256 |
55d36931b3f721d3546980908efbd23f4c2b240be53b46b58de4a527b57e5363
|
