ListIntegrationRoles

GET/api/v1/integrations/{integration}/roles

Example request

US

curl \
  -H "Authorization: Bearer ${OBLIQUE_API_KEY}" \
  "https://us.oblique.security/api/v1/integrations/{integration}/roles"

Set OBLIQUE_API_KEY to your API key.

Europe

curl \
  -H "Authorization: Bearer ${OBLIQUE_API_KEY}" \
  "https://eu.oblique.security/api/v1/integrations/{integration}/roles"

Set OBLIQUE_API_KEY to your API key.

Path parameters

• parentstringrequired

  The parent integration of the format integrations/{integration}.

Query parameters

• pageSizeinteger (int32)
• pageTokenstring
• showDeletedboolean

  If true, the response will include deleted roles.

Response

200ListIntegrationRolesResponse

• integrationRolesIntegrationRole[]
  • namestring

    Assigned by Oblique.

  • displayNamestringread-only

    Human-readable name of the role, as the integration reports it.

  • descriptionstringread-only

    Human-readable description of the role, as the integration reports it. Not set if the integration doesn’t describe its roles.

  • createTimestring (date-time)read-only

    Create and update timestamps.

  • updateTimestring (date-time)read-only
  • deleteTimestring (date-time)read-only

    The time when the role was deleted.

  • idstringread-only

    The identifier the integration uses for this role. Unique within the integration for a set of resource kinds, but may overlap between integrations or even kinds of resources within the same integration. For example, a “GitHub Team ‘admin’” may have the same ID as a “GitHub Repo ‘admin’”.

  • resourceKindsstring[]read-only

    The kinds of resources this role applies to. For example, “cloudflare_user_group” or “cloudflare_resource_group”.

    This corresponds to the resource metadata oneof, as well as the top level “kind” string, which can be matched against these values.

  • accountCountinteger (int32)read-only

    The number of accounts that hold this role across the integration’s resources. An account granted the role on several resources is counted once, and an account matching no directory user is counted too.

• nextPageTokenstring

Errors

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