Skip to content
ConductorOne Docs
  • Auto
  • Light
  • Dark
Get Started

Retrieve Grants

Search App Entitlements With Expired
get/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/grants

Search app entitlements, include app users, users, expires, discovered.

Path Parameters
app_idstring

The appId field.

app_entitlement_idstring

The appEntitlementId field.

Query Parameters
page_sizenumber
optional

The pageSize field.

formatint32
page_tokenstring
optional

The pageToken field.

Returns
listarray of object
optional

The list field.

Hide ParametersShow Parameters
appEntitlementIdstring
optional

The appEntitlementId field.

appIdstring
optional

The appId field.

appUseridstringappIdstringappUserTypeenumcreatedAtstringdeletedAtstringdisplayNamestringemailstringemailsarray of stringemployeeIdsarray of stringidentityUserIdstringisExternalbooleanprofilemapstatusobjectupdatedAtstringusernamestringusernamesarray of stringC1APIAppV1AppUser
optional

Application User that represents an account in the application.

appUserIdstring
optional

The appUserId field.

discoveredstring
optional
formatdate-time
expiredstring
optional
formatdate-time
grantReasonsarray of object
optional

The grantReasons field.

Hide ParametersShow Parameters
appEntitlementIdstring
optional

The ID of the app entitlement that is associated with the grant reason.

appIdstring
optional

The ID of the app that is associated with the grant reason.

appUserIdstring
optional

The ID of the app user that is associated with the grant reason.

createdAtstring
optional
formatdate-time
deletedAtstring
optional
formatdate-time
derivedIdDatastring
optional

This is the other part of the derived ID which include the details like ticket_id, group_id, etc. This provides the uniqueness.

derivedIdTypestring
optional

This is one part of the derived ID, indicating the type, like "ticket" or "group"

reasonExpiresAtstring
optional
formatdate-time
referenceStrengthenum
optional
"GRANT_REASON_REFERENCE_STRENGTH_UNSPECIFIED" OR "GRANT_REASON_REFERENCE_STRENGTH_WEAK" OR "GRANT_REASON_REFERENCE_STRENGTH_STRONG"

GrantReasonReferenceStrength is used to indicate the strength of the reference to the reason. This is used to determine if a grant should be removed when all strong reasons are removed.

Hide ParametersShow Parameters
"GRANT_REASON_REFERENCE_STRENGTH_UNSPECIFIED"
"GRANT_REASON_REFERENCE_STRENGTH_WEAK"
"GRANT_REASON_REFERENCE_STRENGTH_STRONG"
updatedAtstring
optional
formatdate-time
grantSourcesarray of idstringappIdstringAppEntitlementRef
optional

The grantSources field.

useridstringcreatedAtstringdelegatedUserIdstringdeletedAtstringdepartmentstringdepartmentSourcesarray of C1APIUserV1UserAttributeMappingSourcedirectoryIdsarray of stringdirectoryStatusenumdirectoryStatusSourcesarray of C1APIUserV1UserAttributeMappingSourcedisplayNamestringemailstringemailsarray of stringemailSourcesarray of C1APIUserV1UserAttributeMappingSourceemployeeIdsarray of stringemployeeIdSourcesarray of C1APIUserV1UserAttributeMappingSourceemploymentStatusstringemploymentStatusSourcesarray of C1APIUserV1UserAttributeMappingSourceemploymentTypestringemploymentTypeSourcesarray of C1APIUserV1UserAttributeMappingSourcejobTitlestringjobTitleSourcesarray of C1APIUserV1UserAttributeMappingSourcemanagerIdsarray of stringmanagerSourcesarray of C1APIUserV1UserAttributeMappingSourceprofilemaproleIdsarray of stringstatusenumtypeenumupdatedAtstringusernamestringusernamesarray of stringusernameSourcesarray of C1APIUserV1UserAttributeMappingSourceC1APIUserV1User
optional

The User object provides all of the details for an user, as well as some configuration.

nextPageTokenstring
optional

The nextPageToken field.

Request example cURL
curl https://{tenantDomain}.conductor.one/api/v1/apps/$APP_ID/entitlements/$APP_ENTITLEMENT_ID/grants \
    -H "Authorization: Bearer $CONDUCTORONE_SDK_API_KEY"
200 Example
{
  "list": [
    {
      "appEntitlementId": "appEntitlementId",
      "appId": "appId",
      "appUser": {
        "appUserType": "APP_USER_TYPE_UNSPECIFIED",
        "status": {}
      },
      "appUserId": "appUserId",
      "discovered": "2019-12-27T18:11:19.117Z",
      "expired": "2019-12-27T18:11:19.117Z",
      "grantReasons": [
        {
          "appEntitlementId": "appEntitlementId",
          "appId": "appId",
          "appUserId": "appUserId",
          "createdAt": "2019-12-27T18:11:19.117Z",
          "deletedAt": "2019-12-27T18:11:19.117Z",
          "derivedIdData": "derivedIdData",
          "derivedIdType": "derivedIdType",
          "reasonExpiresAt": "2019-12-27T18:11:19.117Z",
          "referenceStrength": "GRANT_REASON_REFERENCE_STRENGTH_UNSPECIFIED",
          "updatedAt": "2019-12-27T18:11:19.117Z"
        }
      ],
      "grantSources": [
        {
          "id": "id",
          "appId": "appId"
        }
      ],
      "user": {
        "delegatedUserId": "delegatedUserId",
        "roleIds": [
          "string"
        ],
        "status": "UNKNOWN"
      }
    }
  ],
  "nextPageToken": "nextPageToken"
}