openapi: 3.0.1
info:
  title: Actor API Specification
  description: This specification describes the endpoints of the actor service
  version: 0-SNAPSHOT
servers:
- url: http://localhost
  description: local development host
tags:
- name: Actor Management
  description: Management functions for actors
- name: Actor Access Management
  description: Management functions for actor accesses
- name: Actor IDP Affiliation Management
  description: Management functions for actor identity provider affiliations
- name: Actor Invite Management
  description: Management functions for actor invites
- name: Actor Custom Data Management
  description: Management functions for actor custom data
paths:
  /actor/v1/actors:
    get:
      tags:
      - Actor Management
      summary: Get actors
      description: Read actors
      operationId: getActors
      parameters:
      - name: query
        in: query
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActorQueryV1'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/count'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      responses:
        "200":
          description: OK
          headers:
            Page-Offset:
              $ref: '#/components/headers/Page-Offset'
            Page-Limit:
              $ref: '#/components/headers/Page-Limit'
            Page-Total:
              $ref: '#/components/headers/Page-Total'
            Data-Projected:
              $ref: '#/components/headers/Data-Projected'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ActorV1'
            application/x-ndjson:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ActorV1'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
      security:
      - iam-tenant-token: []
    post:
      tags:
      - Actor Management
      summary: Create new actor
      description: Creates a new actor with the given details and idp associations
      operationId: createActor
      parameters:
      - $ref: '#/components/parameters/Application-Firewall-Key'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActorInV1'
        required: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
  /actor/v1/actors/~claim-by-invite:
    post:
      tags:
      - Actor Invite Management
      summary: Claim actor by invite
      description: Claim an existing actor with the invite code and the used identity
        provider authentication
      operationId: claimActor
      parameters:
      - $ref: '#/components/parameters/returnUpdated'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActorInviteClaimInV1'
        required: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorInviteClaimV1'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - external-token: []
  /actor/v1/actors/~list:
    post:
      tags:
      - Actor Management
      summary: List actors
      description: Read actors via a posted query
      operationId: listActors
      parameters:
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/count'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActorQueryV1'
      responses:
        "200":
          description: OK
          headers:
            Page-Offset:
              $ref: '#/components/headers/Page-Offset'
            Page-Limit:
              $ref: '#/components/headers/Page-Limit'
            Page-Total:
              $ref: '#/components/headers/Page-Total'
            Data-Projected:
              $ref: '#/components/headers/Data-Projected'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ActorV1'
            application/x-ndjson:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ActorV1'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
      security:
      - iam-tenant-token: []
  /actor/v1/actors/~tail:
    get:
      tags:
      - Actor Management
      summary: Tail actors
      description: Reads actor information continuously
      operationId: tailActors
      parameters:
      - $ref: '#/components/parameters/sinceChangeId'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      responses:
        "200":
          description: OK
          content:
            application/x-ndjson:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ActorStreamEntryV1'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
      security:
      - iam-tenant-token: []
  /actor/v1/actors/{actor-expression}:
    get:
      tags:
      - Actor Management
      summary: Get actor by expression
      description: Reads an actor with the given actor expression
      operationId: getActorByExpression
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - name: projection
        in: query
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActorProjectionV1'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      responses:
        "200":
          description: OK
          headers:
            Data-Projected:
              $ref: '#/components/headers/Data-Projected'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
      security:
      - iam-tenant-token: []
    delete:
      tags:
      - Actor Management
      summary: Delete actor by expression
      description: Removes an actor with the given actor expression
      operationId: deleteActorByExpression
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      responses:
        "204":
          description: The request is processed and no content was returned
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
  /actor/v1/actors/{actor-expression}/~deactivate:
    post:
      tags:
      - Actor Management
      summary: Deactivate actor by expression
      description: Deactivates an actor with the given actor expression
      operationId: deactivateActorByExpression
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
  /actor/v1/actors/{actor-expression}/~delete-with-options:
    post:
      tags:
      - Actor Management
      summary: Delete actor by expression
      description: Removes an actor with the given actor expression
      operationId: deleteActorByExpressionWithOptions
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActorDeleteOptionsV1'
        required: true
      responses:
        "204":
          description: The request is processed and no content was returned
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
  /actor/v1/actors/{actor-expression}/~reactivate:
    post:
      tags:
      - Actor Management
      summary: Reactivate actor by expression
      description: Reactivates an actor with the given actor expression
      operationId: reactivateActorByExpression
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
  /actor/v1/actors/{actor-expression}/~withdraw:
    post:
      tags:
      - Actor Management
      summary: Withdraw actor by expression
      description: Withdraws an actor with the given actor expression
      operationId: withdrawActorByExpression
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActorWithdrawOptionsV1'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
  /actor/v1/actors/{actor-expression}/accesses:
    put:
      tags:
      - Actor Access Management
      summary: Upsert actor accesses
      description: Replaces actor access entries for the referenced actor
      operationId: upsertActorAccesses
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ActorAccessInV1'
          application/x-ndjson:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ActorAccessInV1'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
    post:
      tags:
      - Actor Access Management
      summary: Create actor accesses
      description: Creates actor access entries for the referenced actor
      operationId: createActorAccesses
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ActorAccessInV1'
          application/x-ndjson:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ActorAccessInV1'
        required: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
    delete:
      tags:
      - Actor Access Management
      summary: Delete actor accesses
      description: Delete actor accesses for the referenced actor by actor access
        id
      operationId: deleteAccesses
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
  /actor/v1/actors/{actor-expression}/accesses/{actor-access-id}:
    delete:
      tags:
      - Actor Access Management
      summary: Delete actor access
      description: Delete actor access for the referenced actor by actor access id
      operationId: deleteAccessByExpression
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/actor-access-id'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
  /actor/v1/actors/{actor-expression}/description:
    put:
      tags:
      - Actor Management
      summary: Set actor description
      description: Updates the description for the referenced actor
      operationId: setDescription
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescriptionValueInV1'
        required: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
    delete:
      tags:
      - Actor Management
      summary: Delete actor description
      description: Removes the description for the referenced actor
      operationId: deleteDescription
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
  /actor/v1/actors/{actor-expression}/identity-provider-affiliations:
    put:
      tags:
      - Actor IDP Affiliation Management
      summary: Upsert actor identity provider affiliations
      description: Sets or replaces identity provider affiliations for the referenced
        actor
      operationId: upsertIdpAffiliations
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/IdpAffiliationInV1'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
    post:
      tags:
      - Actor IDP Affiliation Management
      summary: Create actor identity provider affiliation
      description: Creates an actor identity provider affiliation for the referenced
        actor
      operationId: createIdpAffiliation
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/IdpAffiliationInV1'
        required: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
    delete:
      tags:
      - Actor IDP Affiliation Management
      summary: Delete actor identity provider affiliations
      description: Remove all identity provider affiliations for the referenced actor
      operationId: deleteIdpAffiliations
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
  /actor/v1/actors/{actor-expression}/identity-provider-affiliations/{identity-provider-affiliation-id}:
    delete:
      tags:
      - Actor IDP Affiliation Management
      summary: Delete actor identity provider affiliation
      description: Remove a specific actor identity provider affiliation by id for
        the referenced actor
      operationId: deleteIdpAffiliation
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/identity-provider-affiliation-id'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
  /actor/v1/actors/{actor-expression}/invites:
    put:
      tags:
      - Actor Invite Management
      summary: Replace actor invites
      description: Replaces any existing actor invitations for the referenced actor
        with a new set of invitations
      operationId: replaceActorInvites
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ActorInviteInV1'
          application/x-ndjson:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ActorInviteInV1'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ActorInviteCodeV1'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
    post:
      tags:
      - Actor Invite Management
      summary: Create actor invite
      description: Creates an actor invitation for the referenced actor
      operationId: createActorInvite
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActorInviteInV1'
        required: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorInviteCodeV1'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
    delete:
      tags:
      - Actor Invite Management
      summary: Withdraw actor invites
      description: Cancels any existing actor invitation for the referenced actor
      operationId: withdrawActorInvites
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
  /actor/v1/actors/{actor-expression}/invites/{actor-invite-id}:
    delete:
      tags:
      - Actor Invite Management
      summary: Withdraw actor invite
      description: Cancels an existing actor invitation for the referenced actor
      operationId: withdrawActorInvite
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/actor-invite-id'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
  /actor/v1/actors/{actor-expression}/invites/{actor-invite-id}/expireAt:
    put:
      tags:
      - Actor Invite Management
      summary: Update actor invite expiry
      description: Updates an existing actor invitation expiry timestamp for the referenced
        actor
      operationId: setActorInviteExpireAt
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/actor-invite-id'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActorInviteExpireAtInV1'
        required: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
  /actor/v1/actors/{actor-expression}/name:
    put:
      tags:
      - Actor Management
      summary: Set actor name
      description: Updates the name for the referenced actor
      operationId: setName
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NameLongValueInV1'
        required: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
    delete:
      tags:
      - Actor Management
      summary: Delete actor name
      description: Removes the name for the referenced actor
      operationId: deleteName
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
  /actor/v1/actors/{actor-expression}/custom-attributes/{custom-attribute-type}:
    put:
      tags:
      - Actor Custom Data Management
      summary: Upsert actor custom attribute
      description: Upsert a custom attribute by its type for the given actor
      operationId: upsertCustomAttributeEntry
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/custom-attribute-type'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomAttributeValueInV1'
        required: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "204":
          $ref: '#/components/responses/NoContent'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
    delete:
      tags:
      - Actor Custom Data Management
      summary: Delete actor custom attribute
      description: Remove a custom attribute by its type for the given actor
      operationId: deleteCustomAttributeEntry
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/custom-attribute-type'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "204":
          $ref: '#/components/responses/NoContent'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
      security:
      - iam-tenant-token: []
  /actor/v1/actors/{actor-expression}/custom-ids/{custom-id-type}:
    put:
      tags:
      - Actor Custom Data Management
      summary: Upsert actor custom id
      description: Upsert a custom id by its type for the given actor
      operationId: upsertCustomIdEntry
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/custom-id-type'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomIdInWithoutTypeV1'
        required: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "204":
          $ref: '#/components/responses/NoContent'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
    delete:
      tags:
      - Actor Custom Data Management
      summary: Delete actor custom id
      description: Remove a custom id by its type for the given actor
      operationId: deleteCustomIdEntry
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/custom-id-type'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "204":
          $ref: '#/components/responses/NoContent'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
      security:
      - iam-tenant-token: []
  /actor/v1/actors/{actor-expression}/custom-statuses:
    post:
      tags:
      - Actor Custom Data Management
      summary: Append actor custom statuses
      description: Appends custom statuses for the given actor
      operationId: appendCustomStatuses
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/CustomStatusInV1'
        required: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "204":
          $ref: '#/components/responses/NoContent'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
  /actor/v1/actors/{actor-expression}/custom-statuses/{custom-status-type}:
    put:
      tags:
      - Actor Custom Data Management
      summary: Upsert actor custom status
      description: Upsert a custom status by its type for the given actor
      operationId: upsertCustomStatusEntry
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/custom-status-type'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomStatusInWithoutTypeV1'
        required: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "204":
          $ref: '#/components/responses/NoContent'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
    delete:
      tags:
      - Actor Custom Data Management
      summary: Delete actor custom status
      description: Remove a custom status by its type for the given actor and its
        history
      operationId: deleteCustomStatusEntry
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/custom-status-type'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "204":
          $ref: '#/components/responses/NoContent'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
      security:
      - iam-tenant-token: []
  /actor/v1/actors/{actor-expression}/custom-strings/{custom-string-type}:
    put:
      tags:
      - Actor Custom Data Management
      summary: Upsert actor custom string
      description: Upsert a custom string by its type for the given actor
      operationId: upsertCustomString
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/custom-string-type'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomStringInWithoutTypeV1'
        required: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "204":
          $ref: '#/components/responses/NoContent'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
        "409":
          $ref: '#/components/responses/Conflict'
      security:
      - iam-tenant-token: []
    delete:
      tags:
      - Actor Custom Data Management
      summary: Delete actor custom string
      description: Remove a custom string by its type for the given actor
      operationId: deleteCustomString
      parameters:
      - $ref: '#/components/parameters/actor-expression'
      - $ref: '#/components/parameters/custom-string-type'
      - $ref: '#/components/parameters/returnUpdated'
      - $ref: '#/components/parameters/Application-Firewall-Key'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorV1'
        "204":
          $ref: '#/components/responses/NoContent'
        "400":
          $ref: '#/components/responses/BadRequest'
        "401":
          $ref: '#/components/responses/Unauthorized'
        "403":
          $ref: '#/components/responses/Forbidden'
        "404":
          $ref: '#/components/responses/NotFound'
      security:
      - iam-tenant-token: []
components:
  schemas:
    AccessConditionV1:
      type: object
      properties:
        role:
          $ref: '#/components/schemas/StringConditionV1'
        actorResource:
          $ref: '#/components/schemas/ActorResourceConditionV1'
        nodeResource:
          $ref: '#/components/schemas/NodeResourceConditionV1'
        customResource:
          $ref: '#/components/schemas/CustomResourceConditionV1'
        accessFrom:
          $ref: '#/components/schemas/ZonedDateTimeConditionV1'
        accessTo:
          $ref: '#/components/schemas/ZonedDateTimeConditionV1'
      description: Filter actors based on their accesses
    ActorAccessElementProjectionV1:
      type: object
      properties:
        roleCondition:
          $ref: '#/components/schemas/ActorAccessProjectionConditionV1'
        role:
          $ref: '#/components/schemas/FieldProjectionV1'
        accessFrom:
          $ref: '#/components/schemas/FieldProjectionV1'
        accessTo:
          $ref: '#/components/schemas/FieldProjectionV1'
        resourceActor:
          $ref: '#/components/schemas/FieldProjectionV1'
        resourceNode:
          $ref: '#/components/schemas/FieldProjectionV1'
        resourceCustom:
          $ref: '#/components/schemas/FieldProjectionV1'
        createdAt:
          $ref: '#/components/schemas/FieldProjectionV1'
        createdBy:
          $ref: '#/components/schemas/FieldProjectionV1'
        lastModifiedAt:
          $ref: '#/components/schemas/FieldProjectionV1'
        lastModifiedBy:
          $ref: '#/components/schemas/FieldProjectionV1'
      description: Accesses projection settings
    ActorAccessInV1:
      required:
      - resourceType
      - role
      type: object
      properties:
        role:
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9-_.]{1,64}$"
          type: string
          description: "The identifier of a role, also know as 'roleKey'"
          example: ADMINISTRATOR
        resourceType:
          type: string
          description: States the used resource type
          enum:
          - NONE
          - ACTOR
          - NODE
          - CUSTOM
        resourceActor:
          $ref: '#/components/schemas/ActorAccessResourceActorInV1'
        resourceNode:
          $ref: '#/components/schemas/ActorAccessResourceNodeInV1'
        resourceCustom:
          $ref: '#/components/schemas/ActorAccessResourceCustomInV1'
        accessFrom:
          type: string
          description: Defines the start time of an access entry. If omitted it will
            default to the current server timestamp. This string is formatted according
            to RFC3339.
          format: date-time
        accessTo:
          type: string
          description: "Defines an optional end time of an access entry. If omitted,\
            \ this implies that the access entry has not expired. This string is formatted\
            \ according to RFC3339."
          format: date-time
    ActorAccessProjectionConditionV1:
      required:
      - operator
      - values
      type: object
      properties:
        operator:
          type: string
          description: Operator to be applied in conjunction with 'values' for a match
          default: ANY_OF
          enum:
          - ANY_OF
          - NONE_OF
        values:
          maxItems: 100
          minItems: 0
          type: array
          description: Acceptable value for a subfield condition match
          items:
            type: string
            description: Acceptable value for a subfield condition match
    ActorAccessResourceActorInV1:
      required:
      - actorId
      type: object
      properties:
        actorId:
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9-_.]{1,64}$"
          type: string
          description: The globally unique identifier for an actor
      description: An actor resource reference
    ActorAccessResourceActorV1:
      required:
      - actorId
      - actorType
      type: object
      properties:
        actorId:
          type: string
          description: The globally unique identifier for an actor
        actorType:
          type: string
          description: The actorType of the referenced actor
      description: An actor resource reference
    ActorAccessResourceCustomInV1:
      required:
      - type
      - value
      type: object
      properties:
        type:
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9-_.]{1,64}$"
          type: string
          description: a custom value type for an entity.
          example: "Age, ExternalId, Status, Condition, Tags"
        value:
          maxLength: 128
          minLength: 1
          type: string
          description: The value for a specific entity and its corresponding customIdType
          example: ABC123
      description: A custom typed resource reference
    ActorAccessResourceCustomV1:
      required:
      - type
      - value
      type: object
      properties:
        type:
          type: string
          description: a custom value type for an entity.
          example: "Age, ExternalId, Status, Condition, Tags"
        value:
          type: string
          description: The value for a specific entity and its corresponding customIdType
          example: ABC123
      description: A custom typed resource reference
    ActorAccessResourceNodeInV1:
      required:
      - nodeId
      type: object
      properties:
        nodeId:
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9-_.]{1,64}$"
          type: string
          description: The globally unique identifier for a node
      description: A node resource reference
    ActorAccessResourceNodeV1:
      required:
      - nodeId
      - nodeType
      type: object
      properties:
        nodeId:
          type: string
          description: The globally unique identifier for a node
        nodeType:
          type: string
          description: The nodeType of the referenced node
        ancestorNodeIds:
          type: array
          description: The node ancestor hierarchy starting with the closet parent
            and ending with the most distant grand parent
          items:
            type: string
            description: The globally unique identifier for a node
      description: A node resource reference
    ActorAccessV1:
      required:
      - accessFrom
      - actorAccessId
      - createdAt
      - createdBy
      - lastModifiedAt
      - lastModifiedBy
      - resourceType
      - role
      type: object
      properties:
        actorAccessId:
          type: string
          description: The globally unique identifier for an actor access
        role:
          type: string
          description: "The identifier of a role, also know as 'roleKey'"
          example: ADMINISTRATOR
        resourceType:
          type: string
          description: States the used resource type
        resourceActor:
          $ref: '#/components/schemas/ActorAccessResourceActorV1'
        resourceNode:
          $ref: '#/components/schemas/ActorAccessResourceNodeV1'
        resourceCustom:
          $ref: '#/components/schemas/ActorAccessResourceCustomV1'
        accessFrom:
          type: string
          description: Defines the start time of an access entry. This string is formatted
            according to RFC3339.
          format: date-time
        accessTo:
          type: string
          description: Defines the end time of an access entry. This string is formatted
            according to RFC3339.
          format: date-time
        createdAt:
          type: string
          description: UTC date time when entity was created. This string is formatted
            according to RFC3339.
          format: date-time
        createdBy:
          type: string
          description: The globally unique identifier for an actor
        lastModifiedAt:
          type: string
          description: UTC date time when entity was modified. This string is formatted
            according to RFC3339.
          format: date-time
        lastModifiedBy:
          type: string
          description: The globally unique identifier for an actor
      description: Assigned access for the actor
    ActorAccessesProjectionV1:
      type: object
      properties:
        mode:
          $ref: '#/components/schemas/ProjectionModeTypeV1'
        subfieldProjections:
          maxItems: 100
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/ActorAccessElementProjectionV1'
      description: Actor accesses projection settings
    ActorConditionV1:
      type: object
      properties:
        operator:
          type: string
          description: Operator used when combining several conditions together
          default: AND
          enum:
          - AND
          - OR
        conditions:
          maxItems: 32
          minItems: 0
          type: array
          description: A list of conditions which in combination with any given fieldConditions
            and the given operator should result in true.
          items:
            $ref: '#/components/schemas/ActorConditionV1'
        actorId:
          $ref: '#/components/schemas/StringConditionV1'
        name:
          $ref: '#/components/schemas/StringConditionV1'
        type:
          $ref: '#/components/schemas/StringConditionV1'
        status:
          $ref: '#/components/schemas/ActorStatusConditionV1'
        idpAffiliation:
          $ref: '#/components/schemas/IdpAffiliationConditionV1'
        access:
          $ref: '#/components/schemas/AccessConditionV1'
        invite:
          $ref: '#/components/schemas/InviteConditionV1'
        customId:
          $ref: '#/components/schemas/CustomIdConditionV1'
        customString:
          $ref: '#/components/schemas/CustomStringConditionV1'
        customStatus:
          $ref: '#/components/schemas/CustomStatusConditionV1'
        customAttribute:
          $ref: '#/components/schemas/CustomAttributeConditionV1'
        changeId:
          $ref: '#/components/schemas/ChangeIdConditionV1'
        createdAt:
          $ref: '#/components/schemas/ZonedDateTimeConditionV1'
        createdBy:
          $ref: '#/components/schemas/StringConditionV1'
        lastModifiedBy:
          $ref: '#/components/schemas/StringConditionV1'
        lastModifiedAt:
          $ref: '#/components/schemas/ZonedDateTimeConditionV1'
    ActorDeleteOptionsV1:
      type: object
      properties:
        fieldsToRetain:
          uniqueItems: true
          type: array
          description: A set of fields that are to be retained when deleting an actor
          items:
            type: string
            description: A set of fields that are to be retained when deleting an
              actor
            enum:
            - NAME
            - DESCRIPTION
            - ACCESSES
            - IDENTITIES
            - INVITES
            - CUSTOM_IDS
            - CUSTOM_STRINGS
            - CUSTOM_STATUSES
            - CUSTOM_ATTRIBUTES
    ActorIdpAffiliationElementProjectionV1:
      type: object
      properties:
        idpKeyCondition:
          $ref: '#/components/schemas/ActorIdpAffiliationProjectionConditionV1'
        idpKey:
          $ref: '#/components/schemas/FieldProjectionV1'
        subject:
          $ref: '#/components/schemas/FieldProjectionV1'
        username:
          $ref: '#/components/schemas/FieldProjectionV1'
        verifiedAt:
          $ref: '#/components/schemas/FieldProjectionV1'
        createdAt:
          $ref: '#/components/schemas/FieldProjectionV1'
        createdBy:
          $ref: '#/components/schemas/FieldProjectionV1'
        lastModifiedAt:
          $ref: '#/components/schemas/FieldProjectionV1'
        lastModifiedBy:
          $ref: '#/components/schemas/FieldProjectionV1'
      description: IdpAffiliations projection settings
    ActorIdpAffiliationProjectionConditionV1:
      required:
      - operator
      - values
      type: object
      properties:
        operator:
          type: string
          description: Operator to be applied in conjunction with 'values' for a match
          default: ANY_OF
          enum:
          - ANY_OF
          - NONE_OF
        values:
          maxItems: 100
          minItems: 0
          type: array
          description: Acceptable value for a subfield condition match
          items:
            type: string
            description: Acceptable value for a subfield condition match
    ActorIdpAffiliationsProjectionV1:
      type: object
      properties:
        mode:
          $ref: '#/components/schemas/ProjectionModeTypeV1'
        subfieldProjections:
          maxItems: 100
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/ActorIdpAffiliationElementProjectionV1'
      description: Actor idp affiliations projection settings
    ActorInV1:
      required:
      - type
      type: object
      properties:
        actorIdPrefix:
          maxLength: 16
          pattern: "^[a-zA-Z0-9-_&|#%?<>./:;,!\\[\\]()]{0,16}$"
          type: string
          description: This optional field can be used to give a prefix for the actorId
            which is about to be created
          example: user
        name:
          maxLength: 256
          type: string
          description: "A name, usually for an entity"
          example: John Doe
        description:
          maxLength: 4096
          type: string
          description: "A description, usually for an entity"
          example: "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
        type:
          maxLength: 256
          minLength: 1
          pattern: "^[a-zA-Z0-9-_.]{1,256}$"
          type: string
          description: "The actor type. Used to distinguish different variants and\
            \ to tie configurations, permissions and rules."
          example: "PERSON, DEVICE"
        accesses:
          maxItems: 100
          minItems: 0
          type: array
          description: Assigned access for the actor
          items:
            $ref: '#/components/schemas/ActorAccessInV1'
        idpAffiliations:
          maxItems: 10
          minItems: 0
          type: array
          description: Identity provider identities to associate with this actor
          items:
            $ref: '#/components/schemas/IdpAffiliationInV1'
        customIds:
          maxItems: 10
          minItems: 0
          type: array
          description: CustomIds for the actor. Any customId must be unique within
            a tenant
          items:
            $ref: '#/components/schemas/CustomIdInV1'
        customStrings:
          maxItems: 10
          minItems: 0
          type: array
          description: CustomStrings to be set for the node
          items:
            $ref: '#/components/schemas/CustomStringInV1'
        customStatuses:
          maxItems: 10
          minItems: 0
          type: array
          description: Custom statuses defined by the caller
          items:
            $ref: '#/components/schemas/CustomStatusInV1'
        customAttributes:
          maxItems: 10
          minItems: 0
          type: array
          description: Custom attributes to be defined for the actor
          items:
            $ref: '#/components/schemas/CustomAttributeInV1'
    ActorInviteClaimInV1:
      required:
      - code
      type: object
      properties:
        code:
          type: string
          description: An invite code which can be used to complete an actor invitation
            claim
    ActorInviteClaimV1:
      required:
      - accountId
      - actorId
      - applicationId
      - tenantId
      type: object
      properties:
        accountId:
          type: string
          description: The globally unique identifier for an account
        applicationId:
          type: string
          description: The globally unique identifier for an application
        tenantId:
          type: string
          description: The globally unique identifier for a tenant
        actorId:
          type: string
          description: The globally unique identifier for an actor
    ActorInviteCodeV1:
      required:
      - code
      - inviteId
      type: object
      properties:
        inviteId:
          type: string
          description: The globally unique identifier for an actor invite
        code:
          type: string
          description: An invite code which can be used to complete an actor invitation
            claim
    ActorInviteExpireAtInV1:
      required:
      - expireInSecs
      type: object
      properties:
        expireInSecs:
          type: integer
          description: Number of seconds until the invite code expire
          format: int32
          default: 604800
    ActorInviteInV1:
      required:
      - expireInSecs
      type: object
      properties:
        expireInSecs:
          type: integer
          description: Number of seconds until the invite code expire
          format: int32
          default: 604800
        allowedIdentityProviders:
          maxItems: 10
          minItems: 0
          type: array
          description: A set of allowed identity providers use for the invitee. If
            omitted then any identity provider is allowed.
          items:
            maxLength: 64
            minLength: 1
            pattern: "^[a-zA-Z0-9-_.]{1,64}$"
            type: string
            description: An identity provider key which is used to identity a specific
              identity provider configuration.
            example: idp-1
    ActorInviteV1:
      required:
      - createdAt
      - createdBy
      - inviteId
      - status
      - statusChangedAt
      - statusChangedBy
      type: object
      properties:
        inviteId:
          type: string
          description: The globally unique identifier for an actor invite
        expireAt:
          type: string
          description: The expiration timestamp of the current invitation code. This
            string is formatted according to RFC3339.
          format: date-time
        status:
          type: string
          description: The invite's status
        statusChangedAt:
          type: string
          description: UTC date time when the last invite status change was issued.
            This string is formatted according to RFC3339.
          format: date-time
        statusChangedBy:
          type: string
          description: The globally unique identifier for an actor
        createdAt:
          type: string
          description: UTC date time when the invite was issued. This string is formatted
            according to RFC3339.
          format: date-time
        createdBy:
          type: string
          description: The globally unique identifier for an actor
      description: Any invites for the actor and their respective status
    ActorInvitesProjectionV1:
      type: object
      properties:
        mode:
          $ref: '#/components/schemas/ProjectionModeTypeV1'
        expireAt:
          $ref: '#/components/schemas/FieldProjectionV1'
        status:
          $ref: '#/components/schemas/FieldProjectionV1'
        statusChangedAt:
          $ref: '#/components/schemas/FieldProjectionV1'
        statusChangedBy:
          $ref: '#/components/schemas/FieldProjectionV1'
        createdAt:
          $ref: '#/components/schemas/FieldProjectionV1'
        createdBy:
          $ref: '#/components/schemas/FieldProjectionV1'
      description: Invites projection settings
    ActorProjectionV1:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/FieldProjectionV1'
        description:
          $ref: '#/components/schemas/FieldProjectionV1'
        type:
          $ref: '#/components/schemas/FieldProjectionV1'
        status:
          $ref: '#/components/schemas/StatusProjectionV1'
        accesses:
          $ref: '#/components/schemas/ActorAccessesProjectionV1'
        idpAffiliations:
          $ref: '#/components/schemas/ActorIdpAffiliationsProjectionV1'
        invites:
          $ref: '#/components/schemas/ActorInvitesProjectionV1'
        customIds:
          $ref: '#/components/schemas/CustomIdsProjectionV1'
        customStrings:
          $ref: '#/components/schemas/CustomStringsProjectionV1'
        customStatuses:
          $ref: '#/components/schemas/CustomStatusesProjectionV1'
        customAttributes:
          $ref: '#/components/schemas/CustomAttributesProjectionV1'
        tenantId:
          $ref: '#/components/schemas/FieldProjectionV1'
        createdAt:
          $ref: '#/components/schemas/FieldProjectionV1'
        createdBy:
          $ref: '#/components/schemas/FieldProjectionV1'
        lastModifiedAt:
          $ref: '#/components/schemas/FieldProjectionV1'
        lastModifiedBy:
          $ref: '#/components/schemas/FieldProjectionV1'
    ActorQueryV1:
      type: object
      properties:
        projection:
          $ref: '#/components/schemas/ActorProjectionV1'
        filter:
          $ref: '#/components/schemas/ActorConditionV1'
        sort:
          type: array
          items:
            $ref: '#/components/schemas/ActorSortByV1'
    ActorResourceConditionV1:
      type: object
      properties:
        actorId:
          $ref: '#/components/schemas/StringConditionV1'
        type:
          $ref: '#/components/schemas/StringConditionV1'
      description: Filter actors based on their access actor resource reference
    ActorSortByV1:
      required:
      - field
      type: object
      properties:
        field:
          type: string
          description: The field to sort on
          enum:
          - NAME
          - TYPE
          - STATUS
          - STATUS_TIMESTAMP
          - CUSTOM_ID_VALUE
          - CUSTOM_STATUS_VALUE
          - CUSTOM_STRING_VALUE
          - CREATED_AT
          - LAST_MODIFIED_AT
          - CHANGE_ID
        type:
          type: string
          description: "An optional type selector for the field. Could be used to\
            \ map to underlying field in an array or map. Used together with custom\
            \ data, like custom statuses."
        order:
          type: string
          description: "Sorting order. ASC - ascending, DESC - descending"
          default: ASC
          enum:
          - ASC
          - DESC
    ActorStatusConditionV1:
      type: object
      properties:
        value:
          $ref: '#/components/schemas/ActorStatusValueConditionV1'
        createdAt:
          $ref: '#/components/schemas/ZonedDateTimeConditionV1'
        createdBy:
          $ref: '#/components/schemas/StringConditionV1'
      description: Filter actors based on their status
    ActorStatusValueConditionV1:
      required:
      - operator
      type: object
      properties:
        operator:
          type: string
          description: "Operation applied on conditions made on a field. Example:\
            \ AGE_YEAR GREATER_THAN 16. Note that support for respective operator\
            \ is dependant on the underlying value type. See separate documentation\
            \ for full details."
          enum:
          - EQUALS
          - NOT_EQUALS
          - ANY_OF
          - NONE_OF
          - ALL_OF
          - EXISTS
          - NOT_EXISTS
        values:
          maxItems: 500
          minItems: 0
          type: array
          description: The value(s) to check in conjunction with the supplied operator
          items:
            type: string
            description: The value(s) to check in conjunction with the supplied operator
            enum:
            - REGISTERED
            - VERIFIED
            - ACTIVE
            - INACTIVE
            - WITHDRAWN
      description: Filter actors based on their status value
    ActorStreamEntryV1:
      required:
      - id
      type: object
      properties:
        id:
          type: string
          description: The primary business identifier for the streamed entry
        deleted:
          type: boolean
          description: Details if the entity has been removed
        data:
          $ref: '#/components/schemas/ActorV1'
    ActorV1:
      required:
      - actorId
      - changeId
      - createdAt
      - createdBy
      - lastModifiedAt
      - lastModifiedBy
      - status
      - tenantId
      - type
      type: object
      properties:
        actorId:
          type: string
          description: The globally unique identifier for an actor
        name:
          type: string
          description: "A name, usually for an entity"
          example: John Doe
        description:
          type: string
          description: "A description, usually for an entity"
          example: "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
        type:
          type: string
          description: "The actor type. Used to distinguish different variants and\
            \ to tie configurations, permissions and rules."
          example: "PERSON, DEVICE"
        status:
          $ref: '#/components/schemas/StatusV1'
        accesses:
          type: array
          description: Assigned access for the actor
          items:
            $ref: '#/components/schemas/ActorAccessV1'
        idpAffiliations:
          type: array
          description: Assigned identity provider affiliations for the actor
          items:
            $ref: '#/components/schemas/IdpAffiliationV1'
        invites:
          type: array
          description: Any invites for the actor and their respective status
          items:
            $ref: '#/components/schemas/ActorInviteV1'
        customIds:
          type: array
          description: CustomIds for the actor. Any customId must be unique within
            a tenant
          items:
            $ref: '#/components/schemas/CustomIdV1'
        customStrings:
          type: array
          description: CustomString of the actor
          items:
            $ref: '#/components/schemas/CustomStringV1'
        customStatuses:
          type: array
          description: Custom statuses defined by the caller
          items:
            $ref: '#/components/schemas/CustomStatusV1'
        customAttributes:
          type: array
          description: CustomAttributes to be defined for the actor
          items:
            $ref: '#/components/schemas/CustomAttributeV1'
        tenantId:
          type: string
          description: The globally unique identifier for a tenant
        createdAt:
          type: string
          description: UTC date time when entity was created. This string is formatted
            according to RFC3339.
          format: date-time
        createdBy:
          type: string
          description: The globally unique identifier for an actor
        lastModifiedAt:
          type: string
          description: UTC date time when entity was modified. This string is formatted
            according to RFC3339.
          format: date-time
        lastModifiedBy:
          type: string
          description: The globally unique identifier for an actor
        changeId:
          type: string
          description: Text representation of changeId sequence number
          example: "7380283282446876762"
    ActorWithdrawOptionsV1:
      type: object
      properties:
        fieldsToRemove:
          uniqueItems: true
          type: array
          description: A set of fields that are to be removed when withdrawing the
            actor
          items:
            type: string
            description: A set of fields that are to be removed when withdrawing the
              actor
            enum:
            - NAME
            - DESCRIPTION
            - ACCESSES
            - IDENTITIES
            - INVITES
            - CUSTOM_IDS
            - CUSTOM_STRINGS
            - CUSTOM_STATUSES
            - CUSTOM_ATTRIBUTES
    ChangeIdConditionV1:
      required:
      - operator
      type: object
      properties:
        operator:
          type: string
          description: "Operation applied on conditions made on a field. Example:\
            \ AGE_YEAR GREATER_THAN 16. Note that support for respective operator\
            \ is dependant on the underlying value type. See separate documentation\
            \ for full details."
          enum:
          - EQUALS
          - NOT_EQUALS
          - LESS_THAN
          - LESS_THAN_OR_EQUALS
          - GREATER_THAN
          - GREATER_THAN_OR_EQUALS
          - ANY_OF
          - NONE_OF
          - ALL_OF
          - EXISTS
          - NOT_EXISTS
        values:
          maxItems: 500
          minItems: 0
          type: array
          description: The value(s) to check in conjunction with the supplied operator
          items:
            type: string
            description: Text representation of changeId sequence number
            example: "7380283282446876762"
      description: Filter actors based on their changeId
    CustomAttributeConditionV1:
      required:
      - type
      type: object
      properties:
        type:
          $ref: '#/components/schemas/CustomTypeConditionV1'
      description: Filter actors based on a specific customAttribute
    CustomAttributeElementProjectionV1:
      required:
      - typeCondition
      type: object
      properties:
        typeCondition:
          $ref: '#/components/schemas/CustomAttributeProjectionConditionV1'
      description: CustomAttribute projection settings
    CustomAttributeInV1:
      required:
      - type
      - value
      type: object
      properties:
        type:
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9-_.]{1,64}$"
          type: string
          description: a custom value type for an entity.
          example: "Age, ExternalId, Status, Condition, Tags"
        value:
          type: object
          description: The custom data that is associated with this type
      description: Custom attributes to be defined for the actor
    CustomAttributeProjectionConditionV1:
      required:
      - operator
      - values
      type: object
      properties:
        operator:
          type: string
          description: Operator to be applied in conjunction with 'values' for a match
          default: ANY_OF
          enum:
          - ANY_OF
          - NONE_OF
        values:
          maxItems: 100
          minItems: 0
          type: array
          description: Acceptable value for a subfield condition match
          items:
            type: string
            description: Acceptable value for a subfield condition match
    CustomAttributeV1:
      required:
      - type
      - value
      type: object
      properties:
        type:
          type: string
          description: a custom value type for an entity.
          example: "Age, ExternalId, Status, Condition, Tags"
        value:
          type: object
          description: The custom data that is associated with this type
      description: CustomAttributes to be defined for the actor
    CustomAttributeValueInV1:
      required:
      - value
      type: object
      properties:
        value:
          type: object
          description: The custom data that is associated with this path
    CustomAttributesProjectionV1:
      type: object
      properties:
        mode:
          $ref: '#/components/schemas/ProjectionModeTypeV1'
        subfieldProjections:
          maxItems: 100
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/CustomAttributeElementProjectionV1'
      description: CustomAttributes projection settings
    CustomIdConditionV1:
      required:
      - type
      type: object
      properties:
        type:
          $ref: '#/components/schemas/CustomTypeConditionV1'
        value:
          $ref: '#/components/schemas/StringConditionV1'
      description: Filter actors based on their customId
    CustomIdElementProjectionV1:
      required:
      - typeCondition
      type: object
      properties:
        typeCondition:
          $ref: '#/components/schemas/CustomIdProjectionConditionV1'
      description: CustomIds projection settings
    CustomIdInV1:
      required:
      - type
      - value
      type: object
      properties:
        type:
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9-_.]{1,64}$"
          type: string
          description: a custom value type for an entity.
          example: "Age, ExternalId, Status, Condition, Tags"
        value:
          maxLength: 128
          minLength: 1
          type: string
          description: The value for a specific entity and its corresponding customIdType
          example: ABC123
      description: CustomIds for the actor. Any customId must be unique within a tenant
    CustomIdInWithoutTypeV1:
      required:
      - value
      type: object
      properties:
        value:
          type: string
          description: The value for a specific entity and its corresponding customIdType
          example: ABC123
    CustomIdProjectionConditionV1:
      required:
      - operator
      - values
      type: object
      properties:
        operator:
          type: string
          description: Operator to be applied in conjunction with 'values' for a match
          default: ANY_OF
          enum:
          - ANY_OF
          - NONE_OF
        values:
          maxItems: 100
          minItems: 0
          type: array
          description: Acceptable value for a subfield condition match
          items:
            type: string
            description: Acceptable value for a subfield condition match
    CustomIdV1:
      required:
      - type
      - value
      type: object
      properties:
        type:
          type: string
          description: a custom value type for an entity.
          example: "Age, ExternalId, Status, Condition, Tags"
        value:
          type: string
          description: The value for a specific entity and its corresponding customIdType
          example: ABC123
      description: CustomIds for the actor. Any customId must be unique within a tenant
    CustomIdsProjectionV1:
      type: object
      properties:
        mode:
          $ref: '#/components/schemas/ProjectionModeTypeV1'
        subfieldProjections:
          maxItems: 100
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/CustomIdElementProjectionV1'
      description: CustomIds projection settings
    CustomResourceConditionV1:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/StringConditionV1'
        value:
          $ref: '#/components/schemas/StringConditionV1'
      description: Filter actors based on their access custom resource reference
    CustomStatusConditionV1:
      required:
      - type
      type: object
      properties:
        type:
          $ref: '#/components/schemas/CustomTypeConditionV1'
        value:
          $ref: '#/components/schemas/StringConditionV1'
        historicValue:
          $ref: '#/components/schemas/StringConditionV1'
        note:
          $ref: '#/components/schemas/StringConditionV1'
        createdAt:
          $ref: '#/components/schemas/ZonedDateTimeConditionV1'
        createdBy:
          $ref: '#/components/schemas/StringConditionV1'
        statusFrom:
          $ref: '#/components/schemas/ZonedDateTimeConditionV1'
      description: Filter actors based on a specific customStatus
    CustomStatusElementProjectionV1:
      type: object
      properties:
        typeCondition:
          $ref: '#/components/schemas/CustomStatusProjectionConditionV1'
        note:
          $ref: '#/components/schemas/FieldProjectionV1'
        statusFrom:
          $ref: '#/components/schemas/FieldProjectionV1'
        createdAt:
          $ref: '#/components/schemas/FieldProjectionV1'
        createdBy:
          $ref: '#/components/schemas/FieldProjectionV1'
        previousValues:
          $ref: '#/components/schemas/FieldProjectionV1'
      description: CustomStatusElement projection settings
    CustomStatusInV1:
      required:
      - type
      - value
      type: object
      properties:
        type:
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9-_.]{1,64}$"
          type: string
          description: a custom value type for an entity.
          example: "Age, ExternalId, Status, Condition, Tags"
        value:
          maxLength: 256
          minLength: 1
          type: string
          description: A custom status value
          example: Operational
        note:
          maxLength: 128
          minLength: 0
          type: string
          description: "A note/comment, could be a code or free text."
        statusFrom:
          type: string
          description: User provided date time of when the status was considered started.
            If omitted this will default to the current server timestamp and be the
            same as the created at attribute. This string is formatted according to
            RFC3339.
          format: date-time
    CustomStatusInWithoutTypeV1:
      required:
      - value
      type: object
      properties:
        value:
          maxLength: 256
          minLength: 1
          type: string
          description: A custom status value
          example: Operational
        note:
          maxLength: 128
          minLength: 0
          type: string
          description: "A note/comment, could be a code or free text."
        statusFrom:
          type: string
          description: User provided date time of when the status was considered started.
            If omitted this will default to the current server timestamp and be the
            same as the created at attribute. This string is formatted according to
            RFC3339.
          format: date-time
    CustomStatusPreviousValueV1:
      required:
      - createdAt
      - createdBy
      - replacedAt
      - replacedBy
      - statusFrom
      - statusTo
      - value
      type: object
      properties:
        value:
          type: string
          description: A custom status value
          example: Operational
        note:
          type: string
          description: "A note/comment, could be a code or free text."
        statusFrom:
          type: string
          description: User provided date time of when the status was considered started.
            If this value was omitted when the entry was created then it will have
            the same value as the created at attribute. This string is formatted according
            to RFC3339.
          format: date-time
        statusTo:
          type: string
          description: User provided date time of when the status was considered ended.
            This string is formatted according to RFC3339.
          format: date-time
        createdAt:
          type: string
          description: UTC date time when the custom status was created. This string
            is formatted according to RFC3339.
          format: date-time
        createdBy:
          type: string
          description: The globally unique identifier for an actor
        replacedAt:
          type: string
          description: UTC date time when the custom status was replaced. This string
            is formatted according to RFC3339.
          format: date-time
        replacedBy:
          type: string
          description: The globally unique identifier for an actor
      description: "Historic values for this custom status, ordered by descending\
        \ createdAt"
    CustomStatusProjectionConditionV1:
      required:
      - operator
      - values
      type: object
      properties:
        operator:
          type: string
          description: Operator to be applied in conjunction with 'values' for a match
          default: ANY_OF
          enum:
          - ANY_OF
          - NONE_OF
        values:
          maxItems: 100
          minItems: 0
          type: array
          description: Acceptable value for a subfield condition match
          items:
            type: string
            description: Acceptable value for a subfield condition match
    CustomStatusV1:
      required:
      - createdAt
      - createdBy
      - statusFrom
      - type
      - value
      type: object
      properties:
        type:
          type: string
          description: a custom value type for an entity.
          example: "Age, ExternalId, Status, Condition, Tags"
        value:
          type: string
          description: A custom status value
          example: Operational
        note:
          type: string
          description: "A note/comment, could be a code or free text."
        statusFrom:
          type: string
          description: User provided date time of when the status was considered started.
            If this value was omitted when the entry was created then it will have
            the same value as the created at attribute. This string is formatted according
            to RFC3339.
          format: date-time
        createdAt:
          type: string
          description: UTC date time when the custom status was created. This string
            is formatted according to RFC3339.
          format: date-time
        createdBy:
          type: string
          description: The globally unique identifier for an actor
        previousValues:
          type: array
          description: "Historic values for this custom status, ordered by descending\
            \ createdAt"
          items:
            $ref: '#/components/schemas/CustomStatusPreviousValueV1'
      description: Custom statuses defined by the caller
    CustomStatusesProjectionV1:
      type: object
      properties:
        mode:
          $ref: '#/components/schemas/ProjectionModeTypeV1'
        subfieldProjections:
          maxItems: 100
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/CustomStatusElementProjectionV1'
      description: CustomStatuses projection settings
    CustomStringConditionV1:
      required:
      - type
      type: object
      properties:
        type:
          $ref: '#/components/schemas/CustomTypeConditionV1'
        value:
          $ref: '#/components/schemas/StringConditionV1'
      description: Filter actors based on their customString field
    CustomStringElementProjectionV1:
      required:
      - typeCondition
      type: object
      properties:
        typeCondition:
          $ref: '#/components/schemas/CustomStringProjectionConditionV1'
      description: CustomStrings projection settings
    CustomStringInV1:
      required:
      - type
      - value
      type: object
      properties:
        type:
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9-_.]{1,64}$"
          type: string
          description: a custom value type for an entity.
          example: "Age, ExternalId, Status, Condition, Tags"
        value:
          maxLength: 256
          type: string
          description: A custom string value
          example: ABC123
      description: CustomStrings to be set for the node
    CustomStringInWithoutTypeV1:
      required:
      - value
      type: object
      properties:
        value:
          maxLength: 256
          type: string
          description: A custom string value
          example: ABC123
    CustomStringProjectionConditionV1:
      required:
      - operator
      - values
      type: object
      properties:
        operator:
          type: string
          description: Operator to be applied in conjunction with 'values' for a match
          default: ANY_OF
          enum:
          - ANY_OF
          - NONE_OF
        values:
          maxItems: 100
          minItems: 0
          type: array
          description: Acceptable value for a subfield condition match
          items:
            type: string
            description: Acceptable value for a subfield condition match
    CustomStringV1:
      required:
      - type
      - value
      type: object
      properties:
        type:
          type: string
          description: a custom value type for an entity.
          example: "Age, ExternalId, Status, Condition, Tags"
        value:
          type: string
          description: A custom string value
          example: ABC123
      description: CustomString of the actor
    CustomStringsProjectionV1:
      type: object
      properties:
        mode:
          $ref: '#/components/schemas/ProjectionModeTypeV1'
        subfieldProjections:
          maxItems: 100
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/CustomStringElementProjectionV1'
      description: CustomStrings projection settings
    CustomTypeConditionV1:
      required:
      - value
      type: object
      properties:
        value:
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9-_.]{1,64}$"
          type: string
          description: a custom value type for an entity.
          example: "Age, ExternalId, Status, Condition, Tags"
        operator:
          type: string
          description: Operator used to match type
          default: EXISTS
          enum:
          - EXISTS
          - NOT_EXISTS
      description: Filter customAttribute based on this custom attribute type
    DescriptionValueInV1:
      type: object
      properties:
        description:
          maxLength: 4096
          type: string
          description: "A description, usually for an entity"
          example: "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
    ErrorDetailV1:
      required:
      - code
      type: object
      properties:
        field:
          type: string
          description: A reference to a field or parameter which cannot be processed
        code:
          type: string
          description: "A code which indicated the type of error, documented per service"
        message:
          type: string
          description: "Additional information, intended for developers"
      description: "Additional error details, usually used for form validation. Documented\
        \ per service and endpoint."
    ErrorV1:
      required:
      - errorId
      type: object
      properties:
        errorId:
          type: string
          description: "An error identifier for the request, to be provided in troubleshooting."
        code:
          type: string
          description: An error code which describes this error. Documented per service
            and endpoint.
        message:
          type: string
          description: A human readable message of error. Intended for developers.
        details:
          type: array
          description: "Additional error details, usually used for form validation.\
            \ Documented per service and endpoint."
          items:
            $ref: '#/components/schemas/ErrorDetailV1'
    FieldProjectionV1:
      type: object
      properties:
        mode:
          $ref: '#/components/schemas/ProjectionModeTypeV1'
      description: Field projection settings
    IdpAffiliationConditionV1:
      type: object
      properties:
        idpKey:
          $ref: '#/components/schemas/StringConditionV1'
        subject:
          $ref: '#/components/schemas/StringConditionV1'
        username:
          $ref: '#/components/schemas/StringConditionV1'
      description: Filter actors based on their identity provider affiliation
    IdpAffiliationInV1:
      required:
      - idpKey
      type: object
      properties:
        idpKey:
          maxLength: 64
          minLength: 1
          pattern: "^[a-zA-Z0-9-_.]{1,64}$"
          type: string
          description: An identity provider key which is used to identity a specific
            identity provider configuration.
          example: idp-1
        subject:
          maxLength: 256
          minLength: 1
          type: string
          description: The id of the subject for an identity provider.
        username:
          maxLength: 256
          minLength: 1
          type: string
          description: The username of a subject for an identity provider. Usually
            an email address or AD name. Used when the 'subject' is not known.
    IdpAffiliationV1:
      required:
      - createdAt
      - createdBy
      - idpAffiliationId
      - idpKey
      - lastModifiedAt
      - lastModifiedBy
      type: object
      properties:
        idpAffiliationId:
          type: string
          description: The globally unique identifier for an actor identity provider
            affiliation
        idpKey:
          type: string
          description: An identity provider key which is used to identity a specific
            identity provider configuration.
        subject:
          type: string
          description: The id of the subject for an identity provider.
        username:
          type: string
          description: The username of a subject for an identity provider. Usually
            an email address or AD name. Used when the 'subject' is not known.
        verifiedAt:
          type: string
          description: UTC date time when idpAffiliation was first used. This string
            is formatted according to RFC3339.
          format: date-time
        createdAt:
          type: string
          description: UTC date time when entity was created. This string is formatted
            according to RFC3339.
          format: date-time
        createdBy:
          type: string
          description: The globally unique identifier for an actor
        lastModifiedAt:
          type: string
          description: UTC date time when entity was modified. This string is formatted
            according to RFC3339.
          format: date-time
        lastModifiedBy:
          type: string
          description: The globally unique identifier for an actor
      description: Assigned identity provider affiliations for the actor
    InviteConditionV1:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/InviteStatusCondition'
        expireAt:
          $ref: '#/components/schemas/ZonedDateTimeConditionV1'
      description: Filter actors based on their invite
    InviteStatusCondition:
      required:
      - operator
      type: object
      properties:
        operator:
          type: string
          description: "Operation applied on conditions made on a field. Example:\
            \ AGE_YEAR GREATER_THAN 16. Note that support for respective operator\
            \ is dependant on the underlying value type. See separate documentation\
            \ for full details."
          enum:
          - EQUALS
          - NOT_EQUALS
          - ANY_OF
          - NONE_OF
          - ALL_OF
          - EXISTS
          - NOT_EXISTS
        values:
          maxItems: 500
          minItems: 0
          type: array
          description: The value(s) to check in conjunction with the supplied operator
          items:
            type: string
            description: The value(s) to check in conjunction with the supplied operator
            enum:
            - PENDING
            - WITHDRAWN
            - CLAIMED
      description: Filter actors based on their invite status
    NameLongValueInV1:
      required:
      - name
      type: object
      properties:
        name:
          maxLength: 256
          type: string
          description: "A name, usually for an entity"
          example: John Doe
    NodeResourceConditionV1:
      type: object
      properties:
        nodeId:
          $ref: '#/components/schemas/StringConditionV1'
        ancestorNodeId:
          $ref: '#/components/schemas/StringConditionV1'
        type:
          $ref: '#/components/schemas/StringConditionV1'
      description: Filter actors based on their access node resource reference
    ProjectionModeTypeV1:
      type: string
      description: Indicates if the field shall be included in the result. Defaults
        to INCLUDE if omitted.
      default: INCLUDE
      enum:
      - INCLUDE
      - EXCLUDE
    StatusPreviousValueV1:
      required:
      - createdAt
      - createdBy
      - replacedAt
      - replacedBy
      - value
      type: object
      properties:
        value:
          type: string
          description: A status value
          example: Operational
        createdAt:
          type: string
          description: UTC date time when the status was created. This string is formatted
            according to RFC3339.
          format: date-time
        createdBy:
          type: string
          description: The globally unique identifier for an actor
        replacedAt:
          type: string
          description: UTC date time when the status ended. This string is formatted
            according to RFC3339.
          format: date-time
        replacedBy:
          type: string
          description: The globally unique identifier for an actor
      description: "Historic values for this status, ordered by descending createdAt"
    StatusProjectionV1:
      type: object
      properties:
        mode:
          $ref: '#/components/schemas/ProjectionModeTypeV1'
        createdAt:
          $ref: '#/components/schemas/FieldProjectionV1'
        createdBy:
          $ref: '#/components/schemas/FieldProjectionV1'
        previousValues:
          $ref: '#/components/schemas/FieldProjectionV1'
    StatusV1:
      required:
      - createdAt
      - createdBy
      - value
      type: object
      properties:
        value:
          type: string
          description: A status value
          example: Operational
        createdAt:
          type: string
          description: UTC date time when the status was created. This string is formatted
            according to RFC3339.
          format: date-time
        createdBy:
          type: string
          description: The globally unique identifier for an actor
        previousValues:
          type: array
          description: "Historic values for this status, ordered by descending createdAt"
          items:
            $ref: '#/components/schemas/StatusPreviousValueV1'
    StringConditionV1:
      required:
      - operator
      type: object
      properties:
        operator:
          type: string
          description: "Operation applied on conditions made on a field. Example:\
            \ AGE_YEAR GREATER_THAN 16. Note that support for respective operator\
            \ is dependant on the underlying value type. See separate documentation\
            \ for full details."
          enum:
          - EQUALS
          - NOT_EQUALS
          - LESS_THAN
          - LESS_THAN_OR_EQUALS
          - GREATER_THAN
          - GREATER_THAN_OR_EQUALS
          - REGEXP
          - ANY_OF
          - NONE_OF
          - ALL_OF
          - EXISTS
          - NOT_EXISTS
        values:
          maxItems: 500
          minItems: 0
          type: array
          description: The value(s) to check in conjunction with the supplied operator
          items:
            type: string
            description: The value(s) to check in conjunction with the supplied operator
      description: Filter actors based on their lastModifiedBy
    ZonedDateTimeConditionV1:
      required:
      - operator
      type: object
      properties:
        operator:
          type: string
          description: "Operation applied on conditions made on a field. Example:\
            \ AGE_YEAR GREATER_THAN 16. Note that support for respective operator\
            \ is dependant on the underlying value type. See separate documentation\
            \ for full details."
          enum:
          - PASSED
          - NOT_PASSED
          - EQUALS
          - NOT_EQUALS
          - LESS_THAN
          - LESS_THAN_OR_EQUALS
          - GREATER_THAN
          - GREATER_THAN_OR_EQUALS
          - ANY_OF
          - NONE_OF
          - ALL_OF
          - EXISTS
          - NOT_EXISTS
        values:
          maxItems: 500
          minItems: 0
          type: array
          description: The value(s) to check in conjunction with the supplied operator
          items:
            type: string
            description: The value(s) to check in conjunction with the supplied operator
            format: date-time
      description: Filter actors based on their lastModifiedAt
  responses:
    NoContent:
      description: The request is processed and no content was returned
    BadRequest:
      description: "The request is malformed, see error data for additional information"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorV1'
    Unauthorized:
      description: The request did not have valid authentication credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorV1'
    Forbidden:
      description: The requester is not authorized to perform this action
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorV1'
    NotFound:
      description: The resource could not be found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorV1'
    Conflict:
      description: "The request could not be processed due to a conflict in state,\
        \ see error data for additional information"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorV1'
  parameters:
    Application-Firewall-Key:
      name: Application-Firewall-Key
      in: header
      description: Application firewall authorization key to be used for protected
        services
      required: false
      schema:
        type: string
    actor-access-id:
      name: actor-access-id
      in: path
      required: true
      schema:
        type: string
        description: The globally unique identifier for an actor access
    actor-expression:
      name: actor-expression
      in: path
      required: true
      schema:
        pattern: "^[a-zA-Z0-9-_.]{1,64}$|^[a-zA-Z0-9-_.]{1,64}=.{1,128}$|^myself$"
        type: string
        description: "Used to identify a specific actor. The available options are:\
          \ \n* '{actorId}' - direct actorId reference\n* '{customIdType}={customIdValue}'\
          \ - reference actor by one of its custom identifier\n* 'myself' - the actor\
          \ identified by the used access token"
    actor-invite-id:
      name: actor-invite-id
      in: path
      required: true
      schema:
        type: string
        description: The globally unique identifier for an actor invite
    count:
      name: count
      in: query
      description: Count the total amount of matched records for the given query
      schema:
        type: boolean
        default: false
    custom-attribute-type:
      name: custom-attribute-type
      in: path
      required: true
      schema:
        maxLength: 64
        minLength: 1
        pattern: "^[a-zA-Z0-9-_.]{1,64}$"
        type: string
        description: a custom value type for an entity.
        example: "Age, ExternalId, Status, Condition, Tags"
    custom-id-type:
      name: custom-id-type
      in: path
      required: true
      schema:
        maxLength: 64
        minLength: 1
        pattern: "^[a-zA-Z0-9-_.]{1,64}$"
        type: string
        description: a custom value type for an entity.
        example: "Age, ExternalId, Status, Condition, Tags"
    custom-status-type:
      name: custom-status-type
      in: path
      required: true
      schema:
        maxLength: 64
        minLength: 1
        pattern: "^[a-zA-Z0-9-_.]{1,64}$"
        type: string
        description: a custom value type for an entity.
        example: "Age, ExternalId, Status, Condition, Tags"
    custom-string-type:
      name: custom-string-type
      in: path
      required: true
      schema:
        maxLength: 64
        minLength: 1
        pattern: "^[a-zA-Z0-9-_.]{1,64}$"
        type: string
        description: a custom value type for an entity.
        example: "Age, ExternalId, Status, Condition, Tags"
    identity-provider-affiliation-id:
      name: identity-provider-affiliation-id
      in: path
      required: true
      schema:
        type: string
        description: The globally unique identifier for an actor identity provider
          affiliation
    limit:
      name: limit
      in: query
      description: Maximum limit of returned results
      schema:
        type: integer
        format: int32
        default: 500
    offset:
      name: offset
      in: query
      description: Offset is used to skip results in pagination
      schema:
        type: integer
        format: int32
        default: 0
    returnUpdated:
      name: returnUpdated
      in: query
      description: To return the entity after successful update or not
      schema:
        type: boolean
        default: false
    sinceChangeId:
      name: sinceChangeId
      in: query
      description: Filter records with greater changeId that this value
      schema:
        type: string
        default: "0"
  headers:
    Application-Firewall-Key:
      description: Application firewall authorization key to be used for protected
        services
      required: false
      schema:
        type: string
    Data-Projected:
      description: States if the returned data was projected. Defaults to 'false'
        if omitted
      required: false
      schema:
        type: boolean
    Page-Limit:
      description: The backend determined limit that was used for the query
      required: true
      schema:
        type: integer
        format: int32
    Page-Offset:
      description: "The used offset for the query, used for pagination"
      required: true
      schema:
        type: integer
        format: int32
    Page-Total:
      description: The amount of matched records for the query
      required: false
      schema:
        type: integer
        format: int32
  securitySchemes:
    external-token:
      type: http
      scheme: bearer
      bearerFormat: External token issued by a trusted identity provider
    iam-tenant-token:
      type: http
      scheme: bearer
      bearerFormat: IAM issued jwt token for a generic application