Type alias Responses<ClientRoles, UserRoles>

Type declaration

• GET /organizations: CollectionResponse<Organization, Resource<ClientRoles, UserRoles>>

• GET /organizations/:id: SingleResponse<Organization, Resource<ClientRoles, UserRoles>>

• POST /organizations: SingleResponse<Organization, Resource<ClientRoles, UserRoles>>

• GET /sessions: CollectionResponse<Auth.Api.Session, Resource<ClientRoles, UserRoles>>

• POST /sessions/login/email: {
      data: null;
  }

  • data: null

• POST /sessions/login/password: {
      data: StepResponse | Auth.Api.Authn.Session;
  }

  • data: StepResponse | Auth.Api.Authn.Session

• POST /sessions/login/code: {
      data: StepResponse | Auth.Api.Authn.Session;
  }

  • data: StepResponse | Auth.Api.Authn.Session

• POST /sessions/login/totp: {
      data: StepResponse | Auth.Api.Authn.Session;
  }

  • data: StepResponse | Auth.Api.Authn.Session

• POST /sessions/refresh: {
      data: Auth.Api.Authn.Session;
  }

  • data: Auth.Api.Authn.Session

• POST /sessions/invalidate: {
      data: null;
  }

  • data: null

• GET /users: CollectionResponse<User<UserRoles>, Resource<ClientRoles, UserRoles>>

• GET /users/:id: SingleResponse<User<UserRoles>, Resource<ClientRoles, UserRoles>>

• POST /users: {
      data: Auth.Api.Authn.Session;
  }

  • data: Auth.Api.Authn.Session

• PATCH /users/:id: SingleResponse<User<UserRoles>, Resource<ClientRoles, UserRoles>>

• DELETE /users/:id: {
      data: null;
  }

  • data: null

• GET /users/:id/roles: CollectionResponse<UserRole<UserRoles>>

• POST /users/:id/roles: CollectionResponse<UserRole<UserRoles>>

• DELETE /users/:id/roles/:id: {
      data: null;
  }

  • data: null

• GET /users/:id/emails: CollectionResponse<Email, Resource<ClientRoles, UserRoles>>

• POST /users/:id/emails: SingleResponse<Email, Resource<ClientRoles, UserRoles>>

• DELETE /users/:id/emails/:id: {
      data: null;
  }

  • data: null

• POST /emails/:id/send-verification: {
      data: null;
  }

  • data: null

• POST /emails/:id/verify: SingleResponse<Email, Resource<ClientRoles, UserRoles>>

• GET /organizations/:id/clients: CollectionResponse<Client<ClientRoles>, Resource<ClientRoles, UserRoles>>

• POST /organizations/:id/clients: SingleResponse<Client<ClientRoles> & {
      secret: string;
  }, Resource<ClientRoles, UserRoles>>

• GET /organizations/:id/clients/:id: SingleResponse<Client<ClientRoles>, Resource<ClientRoles, UserRoles>>

• PATCH /organizations/:id/clients/:id: SingleResponse<Client<ClientRoles>, Resource<ClientRoles, UserRoles>>

• DELETE /organizations/:id/clients/:id: {
      data: null;
  }

  • data: null

• POST /organizations/:id/clients/:id/refresh-secret: SingleResponse<Client<ClientRoles> & {
      secret: string;
  }, Resource<ClientRoles, UserRoles>>

• GET /organizations/:id/clients/:id/roles: CollectionResponse<ClientRole<ClientRoles>>

• POST /organizations/:id/clients/:id/roles: CollectionResponse<ClientRole<ClientRoles>>

• DELETE /organizations/:id/clients/:id/roles/:id: {
      data: null;
  }

  • data: null

• GET /organizations/:id/clients/:id/access-restrictions: CollectionResponse<ClientAccessRestriction>

• POST /organizations/:id/clients/:id/access-restrictions: SingleResponse<ClientAccessRestriction>

• DELETE /organizations/:id/clients/:id/access-restrictions/:id: {
      data: null;
  }

  • data: null

• GET /users/:id/memberships: CollectionResponse<OrgMembership, Resource<ClientRoles, UserRoles>>

• GET /organizations/:id/memberships: CollectionResponse<OrgMembership, Resource<ClientRoles, UserRoles>>

• POST /organizations/:id/memberships: CollectionResponse<OrgMembership, Resource<ClientRoles, UserRoles>>

• DELETE /org-memberships/:id: {
      data: null;
  }

  • data: null

• PATCH /org-memberships/:id: SingleResponse<OrgMembership, Resource<ClientRoles, UserRoles>>