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

# List IDP user attribute mappings

> Returns the `IdpUserAttributeMapping` objects of an identity provider or HRIS app.
Each mapping tells Opal which attribute to import from the app on sync and which
Opal user field to store it in.



## OpenAPI

````yaml https://app.opal.dev/openapi.yaml get /apps/{app_id}/user-attribute-mappings
openapi: 3.1.0
info:
  contact:
    email: hello@opal.dev
    name: Opal Team
    url: https://www.opal.dev/
  description: >-
    The Opal API is a RESTful API that allows you to interact with the Opal
    Security platform programmatically.
  title: Opal API
  version: '1.0'
servers:
  - description: Production
    url: https://api.opal.dev/v1
security: []
tags:
  - name: access-rules
    description: Operations related to access rules
  - name: agent-activity
    description: Operations related to agent activity telemetry
  - name: apps
    description: Operations related to apps
  - name: bundles
    description: Operations related to bundles
  - name: campaigns
    description: Operations related to access review campaigns
  - name: configuration-templates
    description: Operations related to configuration templates
  - name: delegations
    description: Operations related to request reviewer delegations
  - name: event-streams
    description: Operations related to event streaming connections
  - name: events
    description: Operations related to events
  - name: groups
    description: Operations related to groups
  - name: group-bindings
    description: Operations related to group bindings
  - name: idp-group-mappings
    description: Operations related to IDP group mappings
  - name: idp-user-attribute-mappings
    description: >-
      Operations related to the user attributes Opal imports from identity
      providers and HRIS apps
  - name: message-channels
    description: Operations related to message channels
  - name: non-human-identities
    description: Operations related to non-human identities
  - name: on-call-schedules
    description: Operations related to on-call schedules
  - name: opal-queries
    description: Operations related to OpalQuery
  - name: opal-scripts
    description: Operations related to OpalScripts
  - name: owners
    description: Operations related to owners
  - name: requests
    description: Operations related to requests
  - name: resources
    description: Operations related to resources
  - name: role-assignments
    description: >-
      Operations related to role assignments (general grants between an entity
      and a principal)
  - name: paladin
    description: Operations related to Paladin
  - name: service-users
    description: Operations related to service users (non-human identities owned by a team)
  - name: sessions
    description: Operations related to sessions
  - name: tags
    description: Operations related to tags
  - name: tokens
    description: Operations related to API tokens
  - name: uars
    description: Operations related to UARs. Deprecated in favor of the `campaigns` API.
  - name: users
    description: Operations related to users
paths:
  /apps/{app_id}/user-attribute-mappings:
    get:
      tags:
        - idp-user-attribute-mappings
      summary: List IDP user attribute mappings
      description: >-
        Returns the `IdpUserAttributeMapping` objects of an identity provider or
        HRIS app.

        Each mapping tells Opal which attribute to import from the app on sync
        and which

        Opal user field to store it in.
      operationId: getIdpUserAttributeMappings
      parameters:
        - description: The ID of the identity provider or HRIS app.
          example: 32acc112-21ff-4669-91c2-21e27683eaa1
          explode: false
          in: path
          name: app_id
          required: true
          schema:
            type: string
            format: uuid
          style: simple
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdpUserAttributeMappingList'
          description: The user attribute mappings of the app.
        '404':
          description: The app does not exist or is not an identity provider or HRIS app.
      security:
        - BearerAuth: []
components:
  schemas:
    IdpUserAttributeMappingList:
      properties:
        mappings:
          items:
            $ref: '#/components/schemas/IdpUserAttributeMapping'
          type: array
      required:
        - mappings
      type: object
    IdpUserAttributeMapping:
      description: >-
        # IdpUserAttributeMapping Object

        ### Description

        An attribute Opal imports from an identity provider or HRIS app, and the
        Opal

        user field it is stored in. A `CUSTOM` mapping is imported as a user
        tag.
      example:
        id: 1b978423-db0a-4037-a4cf-f79c60cb67b3
        app_id: 32acc112-21ff-4669-91c2-21e27683eaa1
        key: managerEmail
        use_as: MANAGER_EMAIL
      properties:
        id:
          description: The ID of the mapping.
          example: 1b978423-db0a-4037-a4cf-f79c60cb67b3
          format: uuid
          type: string
        app_id:
          description: The ID of the identity provider or HRIS app.
          example: 32acc112-21ff-4669-91c2-21e27683eaa1
          format: uuid
          type: string
        key:
          description: The attribute key in the identity provider or HRIS.
          example: managerEmail
          type: string
        use_as:
          $ref: '#/components/schemas/IdpUserAttributeUseAsEnum'
      required:
        - id
        - app_id
        - key
        - use_as
      type: object
    IdpUserAttributeUseAsEnum:
      description: The Opal user field an imported IDP or HRIS attribute is stored in.
      enum:
        - CUSTOM
        - EMAIL
        - FIRST_NAME
        - LAST_NAME
        - PROFILE_URL
        - TITLE
        - TEAM
        - MANAGER_EMAIL
        - SECONDARY_EMAIL
        - GITHUB_USERNAME
        - TELEPORT_USERNAME
      example: MANAGER_EMAIL
      type: string
  securitySchemes:
    BearerAuth:
      scheme: bearer
      type: http

````

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