Get Activity

Get Activity returns an activity by ID

Path Parameters

id string required

Responses

• 200
• 400
• 401
• 403
• 404
• 500
• default

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

activity object
id string
providerId string
resourceId string
accountId string
accountType string
timestamp date-time
authorizations string[]
type string
metadata object
createdAt date-time
Creation time of the provider activity
provider object
id string
type string
urn string
config object
type string
urn string
labels object
property name* string
credentials
appeal object
allowPermanentAccess boolean
allowActiveAccessExtensionIn string
resources object[]
Array [
type string
policy object
id string
version int32
roles object[]
Array [
id string
name string
description string
permissions undefined[]
]
filter string
]
allowedAccountTypes string[]
parameters object[]
Array [
key string
label string
required boolean
description string
]
createdAt date-time
Creation time of the provider
updatedAt date-time
Last update time of the provider
resource object
id string
Resource unique identifier
providerType string
Type of the provider that manages this resource
providerUrn string
Unique resource urn
type string
Type of the resource. Depends on the provider type. For example, for BigQuery, it can be dataset, table, view, etc.
urn string
Unique resource urn
name string
details object
Additional information of the resource that can be updated from Guardian
labels object
property name* string
createdAt date-time
Resource creation timestamp
updatedAt date-time
Resource last update timestamp
isDeleted boolean
Whether the resource is deleted or not
parentId string
Parent resource id
children object[]
List of child resources
Array [
0
1
2
3
4
5
6
7
8
9
]
providerActivityId string
relatedPermissions string[]

{
  "activity": {
    "id": "string",
    "providerId": "string",
    "resourceId": "string",
    "accountId": "string",
    "accountType": "string",
    "timestamp": "2023-10-24T20:41:02.754Z",
    "authorizations": [
      "string"
    ],
    "type": "string",
    "metadata": {},
    "createdAt": "2023-01-01T00:00:00Z",
    "provider": {
      "id": "string",
      "type": "string",
      "urn": "string",
      "config": {
        "type": "string",
        "urn": "string",
        "labels": {},
        "credentials": {},
        "appeal": {
          "allowPermanentAccess": true,
          "allowActiveAccessExtensionIn": "string"
        },
        "resources": [
          {
            "type": "string",
            "policy": {
              "id": "string",
              "version": 0
            },
            "roles": [
              {
                "id": "string",
                "name": "string",
                "description": "string",
                "permissions": [
                  null
                ]
              }
            ],
            "filter": "string"
          }
        ],
        "allowedAccountTypes": [
          "string"
        ],
        "parameters": [
          {
            "key": "string",
            "label": "string",
            "required": true,
            "description": "string"
          }
        ]
      },
      "createdAt": "2023-01-01T00:00:00Z",
      "updatedAt": "2023-01-01T00:00:00Z"
    },
    "resource": {
      "id": "f4b7a3c0-9f9b-4b9b-9b0a-9e4b1a1b1b1b",
      "providerType": "bigquery",
      "providerUrn": "my-bq",
      "type": "table",
      "urn": "string",
      "name": "string",
      "details": {},
      "labels": {},
      "createdAt": "2023-06-07T05:39:56.961Z",
      "updatedAt": "2023-06-07T05:39:56.961Z",
      "isDeleted": true,
      "parentId": "string",
      "children": [
        {}
      ]
    },
    "providerActivityId": "string",
    "relatedPermissions": [
      "string"
    ]
  }
}

Bad Request - The request was malformed or contained invalid parameters.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Unauthorized - Authentication is required

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Forbidden - User does not have permission to access the resource

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Not Found - The requested resource was not found

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Internal Server Error. Returned when theres is something wrong with Frontier server.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...