Skip to content

ListUserAttributes

GET/api/v1/users/{user}/userattributes

List attributes for a given user. Attributes sourced from external systems such as Okta, Google, Slack, and Workday, are used to determine membership in attribute-based Groups.

Example request

curl \
-H "Authorization: Bearer ${OBLIQUE_API_KEY}" \
"https://us.oblique.security/api/v1/users/{user}/userattributes"

Set OBLIQUE_API_KEY to your API key.

Path parameters

  • parentstringrequired

    Format: users/{user}, users/- to list across all users, or users/me to list for the authenticated user.

Query parameters

  • pageSizeinteger (int32)

    The maximum number of user attributes to return. This service may return fewer than this value.

  • pageTokenstring

    A page token, received from a previous ListUserAttributes call.

  • filterstring

    Optional filter to be used. This currently only supports filtering by integration name:

    filter=integration="integrations/okta"

Response

200ListUserAttributesResponse
  • userAttributesUserAttribute[]
    • namestring

      Assigned by Oblique.

    • createTimestring (date-time)read-only

      Create timestamp of the attributes. This is always the same as the parent user.

    • updateTimestring (date-time)read-only

      The last time that attributes were modified.

    • integrationstringrequired

      The integration that manages the attribute.

      Format: integrations/{integration}

    • keystringrequired

      The key of the attribute, such as “department” or “costCenter”.

    • valuestringrequired

      The value of the attribute, such as “Engineering” or “12345”.

  • nextPageTokenstring

Errors

StatusMeaning
400Malformed request
401Missing or invalid API key
403Not allowed for this API key
404Not found
429Too many requests
500Internal server error