Skip to content
JITSudo Docs

Get grant

GET
/v1/grants/{id}
 
curl --request GET \
  --url https://example.com/v1/grants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'X-API-Key: <X-API-Key>' \
  --header 'X-Tenant-ID: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

Header Parameters

Section titled “Header Parameters ”
X-Tenant-ID
required
string format: uuid

Tenant identifier. Must match the tenant associated with the credential. Returns 403 tenant_mismatch if the credential and header belong to different tenants.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
id
required
string format: uuid
request_id

The access request that created this grant. Null for manually-created grants.

string format: uuid
nullable
grantee_id
required
string
resource
required
object
type
required
string
Allowed values: aws_account aws_permission_set aws_s3_bucket aws_rds_instance aws_ec2_instance aws_organizational_unit
id
required

Resource identifier. Format depends on type: aws_account: 12-digit AWS account ID aws_permission_set: permission set ARN aws_s3_bucket: bucket name aws_rds_instance: DB instance ARN aws_ec2_instance: instance ID (i-xxxx) aws_organizational_unit: OU ID (ou-xxxx-xxxxxxxx)

string
action
required
string
status
required
string
Allowed values: active expired revoked
expires_at
string format: date-time
nullable
granted_at
required
string format: date-time
revoked_at
string format: date-time
nullable
metadata
object
key
additional properties
any
created_at
required
string format: date-time
updated_at
required
string format: date-time
Example 
{
  "resource": {
    "type": "aws_account"
  },
  "status": "active"
}

401

Section titled “401 ”

Unauthenticated

Media type application/json
object
code
required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string
message
required

Human-readable description of the error.

string
details

Optional additional context about the error.

object
key
additional properties
any
notices

Policy notices from determining Cedar rules, if applicable.

Array<string>
Example generated
{
  "code": "example",
  "message": "example",
  "details": {},
  "notices": [
    "example"
  ]
}

403

Section titled “403 ”

Forbidden

Media type application/json
object
code
required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string
message
required

Human-readable description of the error.

string
details

Optional additional context about the error.

object
key
additional properties
any
notices

Policy notices from determining Cedar rules, if applicable.

Array<string>
Example generated
{
  "code": "example",
  "message": "example",
  "details": {},
  "notices": [
    "example"
  ]
}

404

Section titled “404 ”

Not found

Media type application/json
object
code
required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string
message
required

Human-readable description of the error.

string
details

Optional additional context about the error.

object
key
additional properties
any
notices

Policy notices from determining Cedar rules, if applicable.

Array<string>
Example generated
{
  "code": "example",
  "message": "example",
  "details": {},
  "notices": [
    "example"
  ]
}