Skip to content
Acriva

GrantAccess

POST
/api/v1/t/{tenant}/access-grants
curl --request POST \
  --url https://example.com/api/v1/t/example/access-grants \
  --header 'Content-Type: application/json' \
  --data '{ "principalType": "Role", "principalId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "scopeType": "Tenant", "scopeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "level": "Read" }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
tenant
required
string

Tenant slug

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
principalType
required
Allowed values: Role User
principalId
required
string format: uuid
scopeType
required
Allowed values: Tenant DocumentType File
scopeId
required
null | string format: uuid
level
required
Allowed values: Read Write Manage

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

Media typeapplication/json
object
id
required
string format: uuid
principalType
required
Allowed values: Role User
principalId
required
string format: uuid
principalName
required
null | string
principalKey
required
null | string
scopeType
required
Allowed values: Tenant DocumentType File
scopeId
required
null | string format: uuid
level
required
Allowed values: Read Write Manage
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
  "principalType": "Role",
  "scopeType": "Tenant",
  "level": "Read"
}

400

Section titled “400”

Bad Request

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
errors
object
key
additional properties
Array<string>
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Section titled “403”

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

409

Section titled “409”

Conflict

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Section titled “429”

Too Many Requests

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}