finbourne-identity-sdk

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}	[EXPERIMENTAL] GetPasswordPolicy: Gets password policy for a user type
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}	[EXPERIMENTAL] UpdatePasswordPolicy: Updates password policy for a user type
IdentityProviderApi	add_scim	PUT /api/identityprovider/scim	AddScim: Add SCIM
IdentityProviderApi	remove_scim	DELETE /api/identityprovider/scim	RemoveScim: Remove SCIM
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	[BETA] CreateNetworkZone: Creates a network zone
NetworkZonesApi	delete_network_zone	DELETE /api/networkzones/{code}	[BETA] DeleteNetworkZone: Deletes a network zone
NetworkZonesApi	get_network_zone	GET /api/networkzones/{code}	[BETA] GetNetworkZone: Retrieve a Network Zone
NetworkZonesApi	list_network_zones	GET /api/networkzones	[BETA] ListNetworkZones: Lists all network zones for a domain
NetworkZonesApi	update_network_zone	PUT /api/networkzones/{code}	[BETA] 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	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_schema	GET /api/users/schema	[EXPERIMENTAL] 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	[EXPERIMENTAL] UpdateUserSchema: Update User Schema

Documentation for Models

• AccessControlledAction
• AccessControlledResource
• ActionId
• AddScimResponse
• ApiKey
• AuthenticationInformation
• CreateApiKey
• CreateApplicationRequest
• CreateNetworkZoneRequest
• CreateRoleRequest
• CreateUserRequest
• CreatedApiKey
• CurrentUserResponse
• ErrorDetail
• IdSelectorDefinition
• IdentifierPartSchema
• IpAddressDefinition
• Link
• ListUsersResponse
• LusidProblemDetails
• LusidValidationProblemDetails
• NetworkZoneDefinitionResponse
• NetworkZonesApplyRules
• OAuthApplication
• PasswordPolicyResponse
• PasswordPolicyResponseAge
• PasswordPolicyResponseComplexity
• PasswordPolicyResponseConditions
• PasswordPolicyResponseLockout
• ResourceListOfAccessControlledResource
• RoleId
• RoleResponse
• SetPassword
• SetPasswordResponse
• SupportAccessExpiry
• SupportAccessExpiryWithRole
• SupportAccessRequest
• SupportAccessResponse
• SupportRole
• SupportRolesResponse
• TemporaryPassword
• UpdateNetworkZoneRequest
• UpdatePasswordPolicyRequest
• UpdatePasswordPolicyRequestAge
• UpdatePasswordPolicyRequestComplexity
• UpdatePasswordPolicyRequestConditions
• UpdatePasswordPolicyRequestLockout
• UpdateRoleRequest
• UpdateUserRequest
• UpdateUserSchemaRequest
• UserResponse
• UserSchemaProperty
• UserSchemaResponse
• UserSummary