Skip to content
AveraAveraAvera Documentation

Overview

Tenant & identity 1.0.0

Section titled “Tenant & identity 1.0.0”

The tenant & identity surface of the Avera REST API: Tenant · Users · Participation · Identity connections · Support access · Audit trail.

Information

  • License: Proprietary
  • OpenAPI version: 3.1.0

Tenant

Section titled “Tenant”
GET
/api/v1/tenant

Users

Section titled “Users”
GET
/api/v1/users/{userId}
POST
/api/v1/users/batch

Participation

Section titled “Participation”
POST
/api/v1/users/me/participation-invitations/{participationId}/accept
PUT
/api/v1/tenants/{tenantId}/participations/{participationId}/roles
POST
/api/v1/tenants/{tenantId}/members/{userId}/auth-method
POST
/api/v1/tenants/{tenantId}/participations/internal
POST
/api/v1/users/me/participation-invitations/{participationId}/decline
DELETE
/api/v1/participations/{participationId}
POST
/api/v1/tenants/{tenantId}/participations/invitations
GET
/api/v1/tenants/{tenantId}/members/local-auth
GET
/api/v1/users/me/participations
GET
/api/v1/tenants/{tenantId}/participations
POST
/api/v1/tenants/{tenantId}/members/{userId}/password

Identity connections

Section titled “Identity connections”
POST
/api/v1/tenants/{tenantId}/identity/providers/{providerId}/test
POST
/api/v1/tenants/{tenantId}/identity/providers/test/complete
POST
/api/v1/tenants/{tenantId}/identity/providers/{providerId}/disable
POST
/api/v1/tenants/{tenantId}/identity/providers/{providerId}/enable
GET
/api/v1/tenants/{tenantId}/identity/handoff
GET
/api/v1/tenants/{tenantId}/identity/providers
POST
/api/v1/tenants/{tenantId}/identity/discovery-preview
POST
/api/v1/tenants/{tenantId}/identity/providers/oidc
DELETE
/api/v1/tenants/{tenantId}/identity/providers/{providerId}
POST
/api/v1/tenants/{tenantId}/identity/providers/{providerId}/client-secret
PUT
/api/v1/tenants/{tenantId}/identity/providers/{providerId}

Support access

Section titled “Support access”
GET
/api/v1/tenant/support-access
POST
/api/v1/tenant/support-access/{sessionId}/revoke

Audit trail

Section titled “Audit trail”
GET
/api/v1/projects/{projectId}/audit-trail
GET
/api/v1/audit-trail

Authentication

Section titled “Authentication”

bearerAuth

Section titled “bearerAuth”

Every request carries a bearer token: the session token issued at sign-in, or an OAuth 2.1 access token from a connector grant. HTTP basic is disabled (see SecurityConfig), and the requirement is declared once here rather than on each operation, since it is the same for the whole API.

Security scheme type: http

Bearer format: JWT