Skip to main content

Create Appeal​

Create Appeal allows a user to create an access request to resources along with the role

Request Body required
    accountId string

    Account ID of the user or service account who is creating the appeal

    resources object[]

    List of resources that the user is requesting access to

  • Array [
    • id string
    role string
    options object
    details object
  • ]
    • accountType string

    Account type of the user or service account who is creating the appeal. For example for BigQuery and Google Cloud IAM values are "user" or "service_account"

    description string
Responses

A successful response.

Schema
    appeals object[]
  • Array [
    • id string
    resourceId string
    policyId string
    policyVersion int64
    status string
    accountId string
    role string
    options object
    expirationDate date-time
    duration string
    labels object
    property name* string
    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
  • ]
    • approvals object[]
  • Array [
    • id string
    name string
    appealId string
    status string
    actor string
    policyId string
    policyVersion int64
    approvers string[]
    appeal object
    0
    1
    2
    3
    4
    5
    6
    7
    8
    9
    createdAt date-time

    Approval creation timestamp

    updatedAt date-time

    Approval last update timestamp

    reason string
  • ]
    • createdAt date-time

    Creation time of the appeal

    updatedAt date-time

    Last update time of the appeal

    details object
    accountType string
    createdBy string
    creator
    permissions string[]
    grant object
    id string
    status string
    accountId string
    accountType string
    resourceId string
    role string
    permissions string[]
    expirationDate date-time
    appealId string
    revokedBy string
    revokedAt date-time

    Timestamp when the grant is revoked

    revokeReason string
    createdBy string
    createdAt date-time

    Creation time of the grant

    updatedAt date-time

    Last update time of the grant

    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
  • ]
    • appeal object
    0
    1
    2
    3
    4
    5
    6
    7
    8
    9
    isPermanent boolean
    source string
    statusInProvider string
    owner string
    description string
  • ]
POST /v1beta1/appeals

Authorization

name: X-Auth-Emailtype: apiKeydescription: Email address of the userin: header

Request

Base URL
http://127.0.0.1:7400
apiKey
Body required
{

  "accountId": "string",

  "resources": [

    {

      "id": "string",

      "role": "string",

      "options": {},

      "details": {}

    }

  ],

  "accountType": "string",

  "description": "string"

}
curl / cURL
curl -L -X POST 'http://127.0.0.1:7400/v1beta1/appeals' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Auth-Email: <API_KEY_VALUE>' \
--data-raw '{
  "accountId": "string",
  "resources": [
    {
      "id": "string",
      "role": "string",
      "options": {},
      "details": {}
    }
  ],
  "accountType": "string",
  "description": "string"
}'