Skip to main content

Identity Access Request Recommendations

This API returns the access request recommendations for the specified identity. The default identity is me which indicates the current user.

Query Parameters
  • identity-id string

    Default value: me

    Get access request recommendations for an identityId. me indicates the current user.

    Example: 2c91808570313110017040b06f344ec9
  • limit integer

    Possible values: <= 15

    Default value: 15

    Max number of results to return.

  • offset int32

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

  • count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Example: true
  • include-translation-messages boolean

    If true it will populate a list of translation messages in the response.

  • filters string

    Filter recommendations using the standard syntax described in V3 API Standard Collection Parameters

    Filtering is supported for the following fields and operators:

    access.name: co

    access.type: eq, in

    access.description: co

  • sorters comma-separated

    Sort results using the standard syntax described in V3 API Standard Collection Parameters

    Sorting is supported for the following fields: access.name, access.type

    By default the recommendations are sorted by highest confidence first.

Responses

List of access request recommendations for the identityId


Schema array
  • identityId UUID

    Identity ID for the recommendation

  • access object
  • id UUID

    ID of access item being recommended.

  • type string

    Possible values: [ACCESS_PROFILE, ROLE]

    The type of access item.

  • name string

    Name of the access item

  • description string

    Description of the access item

  • ignored boolean

    Whether or not the identity has already chosen to ignore this recommendation.

  • requested boolean

    Whether or not the identity has already chosen to request this recommendation.

  • viewed boolean

    Whether or not the identity reportedly viewed this recommendation.

  • messages object[]
  • interpretation string

    Information about why the access item was recommended.

  • translationMessages undefined[]

    The list of translation messages

  • key string

    The key of the translation message

  • values string[]

    The values corresponding to the translation messages

Loading...