> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getprimo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get an offboarding access selection intent

> Return the intent behind the OFFBOARDING_ACCESS_SELECTION task of an offboarding ticket: the leaver accounts Primo proposes to remove, `idps` (email providers, with the account action and the transfer targets) and `apps` (`selected`, and `keptByRuleReason` when the published SaaS rule keeps the account), and `executedAt` once executed. Take the `intentId` from the task (`getTicket`). Name the accounts with `getEmployeeSaasIdentities` of the leaver (`identityId` is the `saasApplicationUserId`, `saasId` the `companySaasApplicationId`). `idps` and `apps` have the shape `updateOffboardingAccessSelectionIntent` takes: read them, adjust them, send them there, then `executeOffboardingAccessSelectionIntent`. Refused with `INTENT_NOT_FOUND`.

Key: ReadScope: Company


## OpenAPI

````yaml https://api.getprimo.com/openapi.json get /offboarding-access-selection-intents/{intentId}
openapi: 3.1.1
info:
  title: Public API - BETA
  description: Read docs on https://docs.getprimo.com/
  version: '1.0'
  contact: {}
servers:
  - url: https://api.getprimo.com
security:
  - apikey: []
tags: []
paths:
  /offboarding-access-selection-intents/{intentId}:
    get:
      tags:
        - Offboardings
      summary: Get an offboarding access selection intent
      description: >-
        Return the intent behind the OFFBOARDING_ACCESS_SELECTION task of an
        offboarding ticket: the leaver accounts Primo proposes to remove, `idps`
        (email providers, with the account action and the transfer targets) and
        `apps` (`selected`, and `keptByRuleReason` when the published SaaS rule
        keeps the account), and `executedAt` once executed. Take the `intentId`
        from the task (`getTicket`). Name the accounts with
        `getEmployeeSaasIdentities` of the leaver (`identityId` is the
        `saasApplicationUserId`, `saasId` the `companySaasApplicationId`).
        `idps` and `apps` have the shape
        `updateOffboardingAccessSelectionIntent` takes: read them, adjust them,
        send them there, then `executeOffboardingAccessSelectionIntent`. Refused
        with `INTENT_NOT_FOUND`.
      operationId: getOffboardingAccessSelectionIntent
      parameters:
        - name: intentId
          required: true
          in: path
          schema:
            type: string
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OffboardingAccessSelectionIntent_Output'
components:
  schemas:
    OffboardingAccessSelectionIntent_Output:
      type: object
      properties:
        id:
          type: string
          description: Intent id, to pass to its update and execute tools
        taskId:
          description: The typed task that tracks this step
          anyOf:
            - type: string
            - type: 'null'
        ticketId:
          description: >-
            The ticket holding that task, usually the offboarding ticket. Null
            if it could not be read back.
          anyOf:
            - type: string
            - type: 'null'
        offboardingId:
          type: string
        executedAt:
          description: When the intent executed; null until then
          anyOf:
            - type: string
              format: date-time
              pattern: >-
                ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
            - type: 'null'
        idps:
          type: array
          items:
            type: object
            properties:
              companySaasApplicationId:
                type: string
              saasApplicationUserId:
                type: string
              selected:
                type: boolean
              accountAction:
                type: string
                enum:
                  - SUSPEND
                  - DELETE
                  - DO_NOTHING
              fileTransferTarget:
                anyOf:
                  - type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - MANAGER
                          - USER
                      employeeId:
                        anyOf:
                          - type: string
                          - type: 'null'
                    required:
                      - type
                      - employeeId
                    additionalProperties: false
                  - type: 'null'
              emailForwardingTarget:
                anyOf:
                  - type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - MANAGER
                          - USER
                      employeeId:
                        anyOf:
                          - type: string
                          - type: 'null'
                    required:
                      - type
                      - employeeId
                    additionalProperties: false
                  - type: 'null'
            required:
              - companySaasApplicationId
              - saasApplicationUserId
              - selected
              - accountAction
              - fileTransferTarget
              - emailForwardingTarget
            additionalProperties: false
        apps:
          type: array
          items:
            type: object
            properties:
              companySaasApplicationId:
                type: string
              saasApplicationUserId:
                type: string
              selected:
                type: boolean
              keptByRuleReason:
                anyOf:
                  - type: string
                  - type: 'null'
            required:
              - companySaasApplicationId
              - saasApplicationUserId
              - selected
              - keptByRuleReason
            additionalProperties: false
      required:
        - id
        - taskId
        - ticketId
        - offboardingId
        - executedAt
        - idps
        - apps
      additionalProperties: false
  securitySchemes:
    apikey:
      scheme: bearer
      bearerFormat: API key
      type: http
      description: >-
        Use your Primo API key in the Authorization header as `Bearer
        <API_KEY>`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.