Back to Repository Authress API

Documentation for API Endpoints

Class	Method	HTTP request	Description
AccessRecords	CreateClaim	Post /v1/claims	Create resource Claim
AccessRecords	CreateRecord	Post /v1/records	Create access record
AccessRecords	CreateRequest	Post /v1/requests	Create access request
AccessRecords	DeleteRecord	Delete /v1/records/{recordId}	Deletes access record
AccessRecords	DeleteRequest	Delete /v1/requests/{requestId}	Deletes access request
AccessRecords	GetRecord	Get /v1/records/{recordId}	Retrieve access record
AccessRecords	GetRecords	Get /v1/records	List access records
AccessRecords	GetRequest	Get /v1/requests/{requestId}	Retrieve access request
AccessRecords	GetRequests	Get /v1/requests	List access requests
AccessRecords	RespondToAccessRequest	Patch /v1/requests/{requestId}	Approve or deny access request
AccessRecords	UpdateRecord	Put /v1/records/{recordId}	Update access record
Accounts	DelegateAuthentication	Post /v1/identities	Link external provider
Accounts	GetAccount	Get /v1/accounts/{accountId}	Retrieve account information
Accounts	GetAccountIdentities	Get /v1/identities	List linked external providers
Accounts	GetAccounts	Get /v1/accounts	List user Authress accounts
Applications	DelegateUserLogin	Post /v1/applications/{applicationId}/users/{userId}/delegation	Log user into third-party application
Connections	CreateConnection	Post /v1/connections	Create SSO connection
Connections	DeleteConnection	Delete /v1/connections/{connectionId}	Delete SSO connection
Connections	GetConnection	Get /v1/connections/{connectionId}	Retrieve SSO connection
Connections	GetConnectionCredentials	Get /v1/connections/{connectionId}/users/{userId}/credentials	Retrieve user connection credentials
Connections	GetConnections	Get /v1/connections	List SSO connections
Connections	UpdateConnection	Put /v1/connections/{connectionId}	Update SSO connection
Extensions	CreateExtension	Post /v1/extensions	Create extension
Extensions	DeleteExtension	Delete /v1/extensions/{extensionId}	Delete extension
Extensions	GetExtension	Get /v1/extensions/{extensionId}	Retrieve extension
Extensions	GetExtensions	Get /v1/extensions	List extensions
Extensions	Login	Get /	OAuth Authorize
Extensions	RequestToken	Post /api/authentication/oauth/tokens	OAuth Token
Extensions	UpdateExtension	Put /v1/extensions/{extensionId}	Update extension
Groups	CreateGroup	Post /v1/groups	Create group
Groups	DeleteGroup	Delete /v1/groups/{groupId}	Deletes group
Groups	GetGroup	Get /v1/groups/{groupId}	Retrieve group
Groups	GetGroups	Get /v1/groups	List groups
Groups	UpdateGroup	Put /v1/groups/{groupId}	Update a group
Invites	CreateInvite	Post /v1/invites	Create user invite
Invites	DeleteInvite	Delete /v1/invites/{inviteId}	Delete invite
Invites	GetInvite	Get /v1/invites/{inviteId}	Retrieve invite
Invites	RespondToInvite	Patch /v1/invites/{inviteId}	Accept invite
ResourcePermissions	GetPermissionedResource	Get /v1/resources/{resourceUri}	Retrieve resource configuration
ResourcePermissions	GetPermissionedResources	Get /v1/resources	List all resource configurations
ResourcePermissions	GetResourceUsers	Get /v1/resources/{resourceUri}/users	List users with resource access
ResourcePermissions	UpdatePermissionedResource	Put /v1/resources/{resourceUri}	Update resource configuration
Roles	CreateRole	Post /v1/roles	Create role
Roles	DeleteRole	Delete /v1/roles/{roleId}	Deletes role
Roles	GetRole	Get /v1/roles/{roleId}	Retrieve role
Roles	GetRoles	Get /v1/roles	List roles
Roles	UpdateRole	Put /v1/roles/{roleId}	Update role
ServiceClients	CreateClient	Post /v1/clients	Create service client
ServiceClients	DeleteAccessKey	Delete /v1/clients/{clientId}/access-keys/{keyId}	Delete service client access key
ServiceClients	DeleteClient	Delete /v1/clients/{clientId}	Delete service client
ServiceClients	GetClient	Get /v1/clients/{clientId}	Retrieve service client
ServiceClients	GetClients	Get /v1/clients	List service clients
ServiceClients	RequestAccessKey	Post /v1/clients/{clientId}/access-keys	Generate service client access key
ServiceClients	UpdateClient	Put /v1/clients/{clientId}	Update service client
Tenants	CreateTenant	Post /v1/tenants	Create tenant
Tenants	DeleteTenant	Delete /v1/tenants/{tenantId}	Delete tenant
Tenants	GetTenant	Get /v1/tenants/{tenantId}	Retrieve tenant
Tenants	GetTenants	Get /v1/tenants	List tenants
Tenants	UpdateTenant	Put /v1/tenants/{tenantId}	Update tenant
UserPermissions	AuthorizeUser	Get /v1/users/{userId}/resources/{resourceUri}/permissions/{permission}	Verify user authorization
UserPermissions	GetUserPermissionsForResource	Get /v1/users/{userId}/resources/{resourceUri}/permissions	Get user permissions for resource
UserPermissions	GetUserResources	Get /v1/users/{userId}/resources	List user resources
UserPermissions	GetUserRolesForResource	Get /v1/users/{userId}/resources/{resourceUri}/roles	Get user roles for resource
Users	DeleteUser	Delete /v1/users/{userId}	Delete a user
Users	GetUser	Get /v1/users/{userId}	Retrieve a user
Users	GetUsers	Get /v1/users	List users

Documentation For Models

• AccessRecord
• AccessRecordAccount
• AccessRecordCollection
• AccessRequest
• AccessRequestCollection
• AccessRequestResponse
• AccessTemplate
• Account
• AccountCollection
• AccountLinks
• ApplicationDelegation
• ClaimRequest
• Client
• ClientAccessKey
• ClientCollection
• ClientOptions
• CollectionLinks
• Connection
• ConnectionCollection
• ConnectionData
• ConnectionDefaultConnectionProperties
• ConnectionUserDataConfiguration
• Extension
• ExtensionApplication
• ExtensionClient
• ExtensionCollection
• Group
• GroupCollection
• Identity
• IdentityCollection
• IdentityRequest
• Invite
• Link
• LinkedGroup
• Links
• OAuthAuthorizeResponse
• OAuthTokenRequest
• OAuthTokenResponse
• Pagination
• PaginationNext
• PermissionCollection
• PermissionCollectionAccount
• PermissionObject
• PermissionedResource
• PermissionedResourceCollection
• Resource
• ResourcePermission
• ResourceUsersCollection
• Role
• RoleCollection
• Statement
• Tenant
• TenantCollection
• TenantConnection
• TenantData
• TokenRequest
• User
• UserConnectionCredentials
• UserIdentity
• UserIdentityCollection
• UserResourcesCollection
• UserRole
• UserRoleCollection
• UserToken