Access Requests

List Access Requests

get

Authorizations

Query parameters

limitinteger · int32OptionalDefault: 100

page_tokenstring | nullableOptional

statusesstring[] | nullableOptional

Responses

200

OK

application/json

get

GET /api/user/v4/access-requests HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "items": [
    {
      "id": "text",
      "status": "text",
      "duration_in_sec": 1,
      "justification": "text",
      "creation_date": "text",
      "revocation_date": "text",
      "custom_fields": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "access_groups": [
        {
          "integration": {
            "id": "text",
            "name": "text"
          },
          "resource_types": [
            {
              "id": "text",
              "label": "text"
            }
          ]
        }
      ],
      "bundle": {
        "id": "text",
        "name": "text"
      }
    }
  ],
  "pagination": {
    "next_page_token": "text"
  }
}

Create Access Request

post

Authorizations

Body

bundle_referencestring | nullableOptional

Unique identifier or display name of the bundle. Either bundle_reference or entitlements is required

justificationstring | nullableOptional

An explanation or reason for the access request

duration_in_secinteger · int32 | nullableOptional

Duration in seconds for which access is requested

Responses

200

OK

application/json

post

POST /api/user/v4/access-requests HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 184

{
  "bundle_reference": "text",
  "entitlements": [
    {
      "resource_id": "text",
      "permission_id": "text"
    }
  ],
  "justification": "text",
  "duration_in_sec": 1,
  "custom_fields": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

200

OK

[
  {
    "id": "text",
    "status": "text",
    "duration_in_sec": 1,
    "justification": "text",
    "creation_date": "text",
    "revocation_date": "text",
    "custom_fields": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "access_groups": [
      {
        "integration": {
          "id": "text",
          "name": "text"
        },
        "resource_types": [
          {
            "id": "text",
            "label": "text"
          }
        ]
      }
    ],
    "bundle": {
      "id": "text",
      "name": "text"
    }
  }
]

Get Access Request

get

Authorizations

Path parameters

idstringRequired

Responses

200

OK

application/json

get

GET /api/user/v4/access-requests/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "id": "text",
  "status": "text",
  "duration_in_sec": 1,
  "justification": "text",
  "creation_date": "text",
  "revocation_date": "text",
  "custom_fields": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "access_groups": [
    {
      "integration": {
        "id": "text",
        "name": "text"
      },
      "resource_types": [
        {
          "id": "text",
          "label": "text"
        }
      ]
    }
  ],
  "bundle": {
    "id": "text",
    "name": "text"
  }
}

Get Access Request Entitlements

get

Authorizations

Path parameters

idstringRequired

Query parameters

integration_idsstring[] | nullableOptional

limitinteger · int32OptionalDefault: 100

page_tokenstring | nullableOptional

resource_typesstring[] | nullableOptional

statusesstring[] | nullableOptional

Responses

200

OK

application/json

get

GET /api/user/v4/access-requests/{id}/entitlements HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "items": [
    {
      "integration": {
        "id": "text",
        "name": "text"
      },
      "resource": {
        "id": "text",
        "source_id": "text",
        "type": {
          "id": "text",
          "label": "text"
        },
        "name": "text"
      },
      "permission": {
        "name": "text"
      },
      "status": "text"
    }
  ],
  "pagination": {
    "next_page_token": "text"
  }
}

Request Access Again

post

Authorizations

Path parameters

idstringRequired

Body

justificationstring | nullableOptional

An explanation or reason for the access request

Responses

200

OK

application/json

post

POST /api/user/v4/access-requests/{id}/request-again HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "justification": "text",
  "custom_fields": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

200

OK

[
  {
    "id": "text",
    "status": "text",
    "duration_in_sec": 1,
    "justification": "text",
    "creation_date": "text",
    "revocation_date": "text",
    "custom_fields": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "access_groups": [
      {
        "integration": {
          "id": "text",
          "name": "text"
        },
        "resource_types": [
          {
            "id": "text",
            "label": "text"
          }
        ]
      }
    ],
    "bundle": {
      "id": "text",
      "name": "text"
    }
  }
]

Revoke Access Request

post

Authorizations

Path parameters

idstringRequired

Responses

200

OK

application/json

post

POST /api/user/v4/access-requests/{id}/revoke HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "message": "text"
}

list access requests

get

Authorizations

Query parameters

days_offsetinteger · int64 | nullableOptional

user_idstring | nullableOptional

Responses

200

OK

application/json

get

GET /api/v3/access-requests HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "data": [
    {
      "request_id": "text",
      "friendly_request_id": "text",
      "user_id": "text",
      "status": "PENDING",
      "integration_id": "text",
      "resource_ids": [
        "text"
      ],
      "permissions": [
        "text"
      ],
      "justification": "text"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}

create access request

post

Authorizations

Body

user_idstringRequired

integration_idstringRequired

resource_idsstring[]Required

permissionsstring[]Required

justificationstringRequired

duration_in_secinteger · int32 | nullableOptional

Responses

200

OK

application/json

post

POST /api/v3/access-requests HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 132

{
  "user_id": "text",
  "integration_id": "text",
  "resource_ids": [
    "text"
  ],
  "permissions": [
    "text"
  ],
  "justification": "text",
  "duration_in_sec": 1
}

200

OK

{
  "request_id": "text",
  "friendly_request_id": "text",
  "user_id": "text",
  "status": "PENDING",
  "integration_id": "text",
  "resource_ids": [
    "text"
  ],
  "permissions": [
    "text"
  ],
  "justification": "text"
}

Revoke multiple access requests

post

Authorizations

Body

request_idsstring[]Required

Responses

200

OK

application/json

post

POST /api/v3/access-requests-bulk/revoke HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "request_ids": [
    "text"
  ]
}

200

OK

{
  "message": "text"
}

get access request

get

Authorizations

Path parameters

idstringRequired

Responses

200

OK

application/json

get

GET /api/v3/access-requests/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "request_id": "text",
  "friendly_request_id": "text",
  "user_id": "text",
  "status": "PENDING",
  "integration_id": "text",
  "resource_ids": [
    "text"
  ],
  "permissions": [
    "text"
  ],
  "justification": "text"
}

get access request access details

get

Authorizations

Path parameters

idstringRequired

Responses

200

OK

application/json

get

GET /api/v3/access-requests/{id}/access-details HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "details": "text"
}

reset access request credentials

post

Authorizations

Path parameters

idstringRequired

Responses

200

OK

application/json

post

POST /api/v3/access-requests/{id}/reset HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "message": "text"
}

get selectable integrations

get

Authorizations

Query parameters

user_idstring | nullableOptional

Responses

200

OK

application/json

get

GET /api/v3/selectable-integrations HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "data": [
    {
      "id": "text"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}

get selectable resource types

get

Authorizations

Path parameters

integration_idstring | nullableRequired

Query parameters

user_idstring | nullableOptional

Responses

200

OK

application/json

get

GET /api/v3/selectable-integrations/{integration_id}/resource-types HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "data": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}

get selectable permissions

get

Authorizations

Path parameters

integration_idstring | nullableRequired

resource_typestringRequired

Query parameters

user_idstring | nullableOptional

Responses

200

OK

application/json

get

GET /api/v3/selectable-integrations/{integration_id}/{resource_type}/permissions HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "data": [
    "text"
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  },
  "allow_multiple": true
}

get selectable resources

get

Authorizations

Path parameters

integration_idstring | nullableRequired

resource_typestringRequired

Query parameters

user_idstring | nullableOptional

Responses

200

OK

application/json

get

GET /api/v3/selectable-integrations/{integration_id}/{resource_type}/resources HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "data": [
    {
      "id": "text",
      "type": "text",
      "name": "text"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}