Skip to content

Latest commit

 

History

History
149 lines (141 loc) · 12.3 KB

README.md

File metadata and controls

149 lines (141 loc) · 12.3 KB
Raw

Back to Repository

Documentation for API Endpoints

All URIs are relative to your Authress Host URL.

Class Method HTTP request Description
authress.access_records create_claim POST /v1/claims Create resource Claim
authress.access_records create_invite POST /v1/invites Create user invite
authress.access_records create_record POST /v1/records Create access record
authress.access_records create_request POST /v1/requests Create access request
authress.access_records delete_invite DELETE /v1/invites/{inviteId} Delete invite
authress.access_records delete_record DELETE /v1/records/{recordId} Deletes access record
authress.access_records delete_request DELETE /v1/requests/{requestId} Deletes access request
authress.access_records get_record GET /v1/records/{recordId} Retrieve access record
authress.access_records get_records GET /v1/records List access records
authress.access_records get_request GET /v1/requests/{requestId} Retrieve access request
authress.access_records get_requests GET /v1/requests List access requests
authress.access_records respond_to_access_request PATCH /v1/requests/{requestId} Approve or deny access request
authress.access_records respond_to_invite PATCH /v1/invites/{inviteId} Accept invite
authress.access_records update_record PUT /v1/records/{recordId} Update access record
authress.accounts delegate_authentication POST /v1/identities Link external provider
authress.accounts get_account GET /v1/accounts/{accountId} Retrieve account information
authress.accounts get_account_identities GET /v1/identities List linked external providers
authress.accounts get_accounts GET /v1/accounts List user Authress accounts
authress.applications delegate_user_login POST /v1/applications/{applicationId}/users/{userId}/delegation Log user into third-party application
authress.connections create_connection POST /v1/connections Create SSO connection
authress.connections delete_connection DELETE /v1/connections/{connectionId} Delete SSO connection
authress.connections get_connection GET /v1/connections/{connectionId} Retrieve SSO connection
authress.connections get_connection_credentials GET /v1/connections/{connectionId}/users/{userId}/credentials Retrieve user connection credentials
authress.connections get_connections GET /v1/connections List SSO connections
authress.connections update_connection PUT /v1/connections/{connectionId} Update SSO connection
authress.extensions create_extension POST /v1/extensions Create extension
authress.extensions delete_extension DELETE /v1/extensions/{extensionId} Delete extension
authress.extensions get_extension GET /v1/extensions/{extensionId} Retrieve extension
authress.extensions get_extensions GET /v1/extensions List extensions
authress.extensions login GET / OAuth Authorize
authress.extensions request_token POST /api/authentication/oauth/tokens OAuth Token
authress.extensions update_extension PUT /v1/extensions/{extensionId} Update extension
authress.groups create_group POST /v1/groups Create group
authress.groups delete_group DELETE /v1/groups/{groupId} Deletes group
authress.groups get_group GET /v1/groups/{groupId} Retrieve group
authress.groups get_groups GET /v1/groups List groups
authress.groups update_group PUT /v1/groups/{groupId} Update a group
authress.invites create_invite POST /v1/invites Create user invite
authress.invites delete_invite DELETE /v1/invites/{inviteId} Delete invite
authress.invites get_invite GET /v1/invites/{inviteId} Retrieve invite
authress.invites respond_to_invite PATCH /v1/invites/{inviteId} Accept invite
authress.resource_permissions get_permissioned_resource GET /v1/resources/{resourceUri} Retrieve resource configuration
authress.resource_permissions get_permissioned_resources GET /v1/resources List all resource configurations
authress.resource_permissions get_resource_users GET /v1/resources/{resourceUri}/users List users with resource access
authress.resource_permissions update_permissioned_resource PUT /v1/resources/{resourceUri} Update resource configuration
authress.roles create_role POST /v1/roles Create role
authress.roles delete_role DELETE /v1/roles/{roleId} Deletes role
authress.roles get_role GET /v1/roles/{roleId} Retrieve role
authress.roles get_roles GET /v1/roles List roles
authress.roles update_role PUT /v1/roles/{roleId} Update role
authress.service_clients create_client POST /v1/clients Create service client
authress.service_clients delete_access_key DELETE /v1/clients/{clientId}/access-keys/{keyId} Delete service client access key
authress.service_clients delete_client DELETE /v1/clients/{clientId} Delete service client
authress.service_clients get_client GET /v1/clients/{clientId} Retrieve service client
authress.service_clients get_clients GET /v1/clients List service clients
authress.service_clients request_access_key POST /v1/clients/{clientId}/access-keys Generate service client access key
authress.service_clients update_client PUT /v1/clients/{clientId} Update service client
authress.tenants create_tenant POST /v1/tenants Create tenant
authress.tenants delete_tenant DELETE /v1/tenants/{tenantId} Delete tenant
authress.tenants get_tenant GET /v1/tenants/{tenantId} Retrieve tenant
authress.tenants get_tenants GET /v1/tenants List tenants
authress.tenants update_tenant PUT /v1/tenants/{tenantId} Update tenant
authress.user_permissions authorize_user GET /v1/users/{userId}/resources/{resourceUri}/permissions/{permission} Verify user authorization
authress.user_permissions get_user_permissions_for_resource GET /v1/users/{userId}/resources/{resourceUri}/permissions Get user permissions for resource
authress.user_permissions get_user_resources GET /v1/users/{userId}/resources List user resources
authress.user_permissions get_user_roles_for_resource GET /v1/users/{userId}/resources/{resourceUri}/roles Get user roles for resource
authress.users delete_user DELETE /v1/users/{userId} Delete a user
authress.users get_user GET /v1/users/{userId} Retrieve a user
authress.users get_users GET /v1/users List users

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open