Skip to main content

Get a paginated list of common access

This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read

Query Parameters
  • 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.

  • limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
  • 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
  • filters string

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

    Filtering is supported for the following fields and operators:

    status: eq "CONFIRMED" or "DENIED" reviewedByUser eq true or false access.id: eq "id" access.type: eq "ROLE" or "ACCESS_PROFILE" access.name: sw "Administrator" access.description: sw "admin"

  • 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,status

    By default the common access items are sorted by name, ascending.

Responses

Succeeded. Returns a list of common access for a customer.


Schema array
  • access object

    common access item

  • id string

    Common access ID

  • type string

    Possible values: [ACCESS_PROFILE, ROLE]

    Common access type (ROLE or ACCESS_PROFILE)

  • name string

    Common access name

  • description string

    Common access description

  • ownerName string

    Common access owner name

  • ownerId string

    Common access owner ID

  • status string

    CONFIRMED or DENIED

  • lastUpdated date-time
  • reviewedByUser boolean

    true if user has confirmed or denied status

  • lastReviewed date-time
Loading...