---
descriptions:
  profile:
    object: Distinguishes the Profile object.
    id: >
      Unique identifier for the user, assigned by WorkOS.


      This value can be persisted to the Developer’s user model and used as a
      unique key for identifying a specific user.
    connection_id: Unique identifier for the Connection to which the Profile belongs.
    organization_id: Unique identifier for the Organization in which the Connection resides.
    email: The user’s email address.
    first_name: The user’s first name.
    last_name: The user’s last name.
    idp_id: >
      Unique identifier for the user, assigned by the Identity Provider.
      Different Identity Providers use different ID formats.


      One possible use case for idp_id is associating a user’s SSO Profile with
      any relevant Directory Sync actions related to that user.
    role:
      slug: >-
        Unique identifier for the role, assigned [based on group
        memberships](/sso/identity-provider-role-assignment) at sign-in.
    custom_attributes: >
      Object containing custom attributes that have been mapped from the
      Identity Provider. These attributes are configured in the [WorkOS
      Dashboard](https://dashboard.workos.com/) and can include both predefined
      and custom attributes.


      For more information about configuring custom attributes, see the [Profile
      Attributes](/sso/attributes) guide.
    self: 'The user [Profile](/reference/sso/profile) object.'
reference:
  curl:
    - url: /reference/sso/profile
      key: profile
      id: profile
      title: profile
      properties:
        - key: object
          type: '"profile"'
          description: (profile.object)
        - key: id
          type: string
          description: (profile.id)
        - key: connection_id
          type: string
          description: (profile.connection_id)
        - key: connection_type
          type: enum
          description: (connection.connection_type)
        - key: organization_id
          optional: true
          type: string
          description: (profile.organization_id)
        - key: email
          type: string
          description: (profile.email)
        - key: first_name
          type: string
          description: (profile.first_name)
        - key: last_name
          type: string
          description: (profile.last_name)
        - key: idp_id
          type: string
          description: (profile.idp_id)
        - key: role
          type: object
          description: (profile.role)
          properties:
            - key: slug
              type: string
              description: (profile.role.slug)
        - key: custom_attributes
          type: object
          description: (profile.custom_attributes)
  dotnet:
    - url: /reference/sso/profile
      key: Profile
      id: profile
      title: class Profile
      properties:
        - key: Object
          type: '"profile"'
          description: (profile.object)
        - key: Id
          type: string
          description: (profile.id)
        - key: IdpId
          type: string
          description: (profile.idp_id)
        - key: ConnectionId
          type: string
          description: (profile.connection_id)
        - key: Type
          type: string
          description: (connection.connection_type)
        - key: OrganizationId
          optional: true
          type: string
          description: (profile.organization_id)
        - key: Email
          type: string
          description: (profile.email)
        - key: FirstName
          type: string
          description: (profile.first_name)
        - key: LastName
          type: string
          description: (profile.last_name)
        - key: CustomAttributes
          type: 'Dictionary<string, object>'
          description: (profile.custom_attributes)
  ruby:
    - url: /reference/sso/profile
      key: Profile
      id: profile
      title: class Profile
      properties:
        - key: id
          type: String
          description: (profile.id)
        - key: connection_id
          type: String
          description: (profile.connection_id)
        - key: connection_type
          type: String
          description: (connection.connection_type)
        - key: organization_id
          optional: true
          type: String
          description: (profile.organization_id)
        - key: email
          type: String
          description: (profile.email)
        - key: first_name
          type: String
          description: (profile.first_name)
        - key: last_name
          type: String
          description: (profile.last_name)
        - key: idp_id
          type: String
          description: (profile.idp_id)
        - key: role
          type: object
          description: (profile.role)
          properties:
            - key: slug
              type: String
              description: (profile.role.slug)
        - key: custom_attributes
          type: Hash
          description: (profile.custom_attributes)
  php:
    - url: /reference/sso/profile
      key: Profile
      id: profile
      title: WorkOS\Resource\Profile
      properties:
        - key: id
          type: string
          description: (profile.id)
        - key: connectionId
          type: string
          description: (profile.connection_id)
        - key: connectionType
          type: string
          description: (connection.connection_type)
        - key: organizationId
          optional: true
          type: string
          description: (profile.organization_id)
        - key: email
          type: string
          description: (profile.email)
        - key: firstName
          type: string
          description: (profile.first_name)
        - key: lastName
          type: string
          description: (profile.last_name)
        - key: idpId
          type: string
          description: (profile.idp_id)
        - key: customAttributes
          type: array
          description: (profile.custom_attributes)
  python:
    - url: /reference/sso/profile
      key: Profile
      id: profile
      title: Profile
      properties:
        - key: id
          type: str
          description: (profile.id)
        - key: connection_id
          type: str
          description: (profile.connection_id)
        - key: connection_type
          type: ConnectionType
          description: (connection.connection_type)
        - key: organization_id
          optional: true
          type: str
          description: (profile.organization_id)
        - key: email
          type: str
          description: (profile.email)
        - key: first_name
          type: str
          description: (profile.first_name)
        - key: last_name
          type: str
          description: (profile.last_name)
        - key: idp_id
          type: str
          description: (profile.idp_id)
        - key: role
          type: ProfileRole
          description: (profile.role)
          properties:
            - key: slug
              type: str
              description: (profile.role.slug)
        - key: custom_attributes
          type: dict
          description: (profile.custom_attributes)
  js:
    - url: /reference/sso/profile
      key: Profile
      id: profile
      title: interface Profile
      properties:
        - key: id
          type: string
          description: (profile.id)
        - key: connectionId
          type: string
          description: (profile.connection_id)
        - key: connectionType
          type: string
          description: (connection.connection_type)
        - key: organizationId
          optional: true
          type: string
          description: (profile.organization_id)
        - key: email
          type: string
          description: (profile.email)
        - key: firstName
          type: string
          description: (profile.first_name)
        - key: lastName
          type: string
          description: (profile.last_name)
        - key: idpId
          type: string
          description: (profile.idp_id)
        - key: role
          type: object
          description: (profile.role)
          properties:
            - key: slug
              type: string
              description: (profile.role.slug)
        - key: customAttributes
          type: object
          description: (profile.custom_attributes)
  go:
    - url: /reference/sso/profile
      key: Profile
      id: profile
      title: sso.Profile
      properties:
        - key: ID
          type: string
          description: (profile.id)
        - key: ConnectionID
          type: string
          description: (profile.connection_id)
        - key: ConnectionType
          type: sso.ConnectionType
          description: (connection.connection_type)
        - key: OrganizationID
          optional: true
          type: string
          description: (profile.organization_id)
        - key: Email
          type: string
          description: (profile.email)
        - key: FirstName
          type: string
          description: (profile.first_name)
        - key: LastName
          type: string
          description: (profile.last_name)
        - key: IdpID
          type: string
          description: (profile.idp_id)
        - key: Role
          type: RoleResponse
          description: (profile.role)
          properties:
            - key: Slug
              type: string
              description: (profile.role.slug)
        - key: CustomAttributes
          type: 'map[string]interface{}'
          description: (profile.custom_attributes)
  java:
    - url: /reference/sso/profile
      key: Profile
      id: profile
      title: class Profile
      properties:
        - key: obj
          type: '"profile"'
          description: (profile.object)
        - key: id
          type: String
          description: (profile.id)
        - key: idpId
          type: String
          description: (profile.idp_id)
        - key: organizationId
          optional: true
          type: String
          description: (profile.organization_id)
        - key: connectionId
          type: String
          description: (profile.connection_id)
        - key: connectionType
          type: ConnectionType
          description: (connection.connection_type)
        - key: email
          type: String
          description: (profile.email)
        - key: firstName
          type: String
          description: (profile.first_name)
        - key: lastName
          type: String
          description: (profile.last_name)
        - key: customAttributes
          type: 'Map<String, Any>'
          description: (profile.custom_attributes)
originalPath: .tmp-workos-clone/packages/docs/content/reference/sso/profile/index.mdx
---

# Profile

A Profile is an object that represents an authenticated user. The Profile object contains information relevant to a user in the form of normalized attributes.

After receiving the Profile for an authenticated user, use the Profile object attributes to persist relevant data to your application’s user model for the specific, authenticated user.

To surface additional attributes on the Profile, refer to the [SSO custom attributes](/sso/attributes/custom-attributes) guide.

<CodeBlock title="Example Profile" file="profile" referenceId="profile" />