finbourne-access-sdk 2.4.1

FINBOURNE Access Management API

Documentation for API Endpoints

All URIs are relative to https://fbn-prd.lusid.com/access

Class	Method	HTTP request	Description
ApplicationMetadataApi	list_access_controlled_resources	GET /api/metadata/access/resources	ListAccessControlledResources: Get resources available for access control
PoliciesApi	add_to_policy_collection	POST /api/policycollections/{code}/add	AddToPolicyCollection: Add To PolicyCollection
PoliciesApi	create_policy	POST /api/policies	CreatePolicy: Create Policy
PoliciesApi	create_policy_collection	POST /api/policycollections	CreatePolicyCollection: Create PolicyCollection
PoliciesApi	delete_policy	DELETE /api/policies/{code}	DeletePolicy: Delete Policy
PoliciesApi	delete_policy_collection	DELETE /api/policycollections/{code}	DeletePolicyCollection: Delete PolicyCollection
PoliciesApi	evaluate	POST /api/me	Evaluate: Run one or more evaluations
PoliciesApi	get_own_policies	GET /api/me	GetOwnPolicies: Get policies of requesting user
PoliciesApi	get_policy	GET /api/policies/{code}	GetPolicy: Get Policy
PoliciesApi	get_policy_collection	GET /api/policycollections/{code}	GetPolicyCollection: Get PolicyCollection
PoliciesApi	list_policies	GET /api/policies	ListPolicies: List Policies
PoliciesApi	list_policy_collections	GET /api/policycollections	ListPolicyCollections: List PolicyCollections
PoliciesApi	page_policies	GET /api/policies/page	PagePolicies: Page Policies
PoliciesApi	page_policy_collections	GET /api/policycollections/page	PagePolicyCollections: Page PolicyCollections
PoliciesApi	remove_from_policy_collection	POST /api/policycollections/{code}/remove	RemoveFromPolicyCollection: Remove From PolicyCollection
PoliciesApi	update_policy	PUT /api/policies/{code}	UpdatePolicy: Update Policy
PoliciesApi	update_policy_collection	PUT /api/policycollections/{code}	UpdatePolicyCollection: Update PolicyCollection
PolicyTemplatesApi	create_policy_template	POST /api/policytemplates	[EXPERIMENTAL] CreatePolicyTemplate: Create a Policy Template
PolicyTemplatesApi	delete_policy_template	DELETE /api/policytemplates/{code}	[EXPERIMENTAL] DeletePolicyTemplate: Deleting a policy template
PolicyTemplatesApi	generate_policy_from_template	POST /api/policytemplates/$generatepolicy	[EXPERIMENTAL] GeneratePolicyFromTemplate: Generate policy from template
PolicyTemplatesApi	get_policy_template	GET /api/policytemplates/{code}	[EXPERIMENTAL] GetPolicyTemplate: Retrieving one Policy Template
PolicyTemplatesApi	list_policy_templates	GET /api/policytemplates	[EXPERIMENTAL] ListPolicyTemplates: List Policy Templates
PolicyTemplatesApi	update_policy_template	PUT /api/policytemplates/{code}	[EXPERIMENTAL] UpdatePolicyTemplate: Update a Policy Template
RolesApi	add_policy_collection_to_role	POST /api/roles/{scope}/{code}/policycollections	AddPolicyCollectionToRole: Add policy collections to a role
RolesApi	create_role	POST /api/roles	CreateRole: Create Role
RolesApi	delete_role	DELETE /api/roles/{code}	DeleteRole: Delete Role
RolesApi	get_role	GET /api/roles/{code}	GetRole: Get Role
RolesApi	list_roles	GET /api/roles	ListRoles: List Roles
RolesApi	remove_policy_collection_from_role	DELETE /api/roles/{scope}/{code}/policycollections/{policycollectionscope}/{policycollectioncode}	RemovePolicyCollectionFromRole: Remove policy collection from role
RolesApi	update_role	PUT /api/roles/{code}	UpdateRole: Update Role
UserRolesApi	add_policy_collection_to_user_role	POST /api/userroles/{userid}/policycollections	AddPolicyCollectionToUserRole: Add a policy collection to a user-role
UserRolesApi	add_policy_to_user_role	POST /api/userroles/{userid}/policies	AddPolicyToUserRole: Add a policy to a user-role
UserRolesApi	create_user_role	POST /api/userroles	CreateUserRole: Create a user-role
UserRolesApi	delete_user_role	DELETE /api/userroles/{userid}	DeleteUserRole: Delete a user-role
UserRolesApi	get_user_role	GET /api/userroles/{userid}	GetUserRole: Get a user-role
UserRolesApi	list_user_roles	GET /api/userroles	ListUserRoles: List user-roles
UserRolesApi	remove_policy_collection_from_user_role	DELETE /api/userroles/{userid}/policycollections/{policyCollectionScope}/{policyCollectionCode}	RemovePolicyCollectionFromUserRole: Remove a policy collection from a user-role
UserRolesApi	remove_policy_from_user_role	DELETE /api/userroles/{userid}/policies/{policyScope}/{policyCode}	RemovePolicyFromUserRole: Remove a policy from a user-role
UserRolesApi	update_user_role	POST /api/userroles/{userid}/update	UpdateUserRole: Update a user-role

Documentation for Models

• AccessControlledAction
• AccessControlledResource
• ActionId
• AddPolicyCollectionToRoleRequest
• AddPolicyToRoleRequest
• AddToPolicyCollectionRequest
• AsAtPredicateContract
• AsAtRangeForSpec
• AsAtRelative
• AttachedPolicyDefinitionResponse
• DateQuality
• DateUnit
• EffectiveDateHasQuality
• EffectiveDateRelative
• EffectiveRange
• EntitlementMetadata
• EvaluationRequest
• EvaluationResponse
• EvaluationResult
• ForSpec
• GeneratePolicyFromTemplateRequest
• GeneratedPolicyComponents
• Grant
• HowSpec
• IdSelectorDefinition
• IdentifierPartSchema
• IfExpression
• IfIdentityClaimExpression
• IfIdentityScopeExpression
• IfRequestHeaderExpression
• IfViaApiExpression
• KeyValuePairOfStringToString
• Link
• LusidProblemDetails
• LusidValidationProblemDetails
• MatchAllSelectorDefinition
• MetadataExpression
• MetadataSelectorDefinition
• NonTransitiveSupervisorRoleResource
• Operator
• PointInTimeSpecification
• PolicyCollectionCreationRequest
• PolicyCollectionId
• PolicyCollectionResponse
• PolicyCollectionUpdateRequest
• PolicyCreationRequest
• PolicyId
• PolicyIdRoleResource
• PolicyResponse
• PolicySelectorDefinition
• PolicyTemplateCreationRequest
• PolicyTemplateResponse
• PolicyTemplateUpdateRequest
• PolicyTemplatedSelector
• PolicyType
• PolicyUpdateRequest
• RelativeToDateTime
• RemoveFromPolicyCollectionRequest
• RequestDetails
• RequestedActionKey
• ResourceDetails
• ResourceListOfAccessControlledResource
• ResourceListOfPolicyCollectionResponse
• ResourceListOfPolicyResponse
• ResourceListOfPolicyTemplateResponse
• ResourceListOfUserRoleResponse
• RoleCreationRequest
• RoleId
• RoleResourceRequest
• RoleResponse
• RoleUpdateRequest
• SelectorDefinition
• TemplateMetadata
• TemplateSelection
• TextOperator
• UserRoleCreationRequest
• UserRoleResponse
• UserRoleUpdateRequest
• WhenSpec