Organization Role Assignments [Beta]

This contains APIs for Organization-scoped Role Assignments.

List role assignments

Retrieves the information of the role assignments

Securityx-api-key
Request
path Parameters
org
required
string

Organization identifier

query Parameters
page
integer
Default: 0

Pagination page number strategy: Specify the page number within the paginated collection related to the number of items on each page.

limit
integer <= 100
Default: 30

Pagination: Number of items to return.

sort
string

Parameter on the basis of which sorting is done.

Enum: "identifier" "name" "created" "updated"
order
string

Order on the basis of which sorting is done.

Enum: "ASC" "DESC"
header Parameters
Harness-Account
string

Identifier field of the account the resource is scoped to.

Responses
200

Role Assignment List Response body

get/v1/orgs/{org}/role-assignments
Request samples
Response samples
[
  • {
    }
]

Create a role assignment

Create a role assignment

Securityx-api-key
Request
path Parameters
org
required
string

Organization identifier

header Parameters
Harness-Account
string

Identifier field of the account the resource is scoped to.

Request Body schema:
required

Role Request body

identifier
required
string

Role assignment identifier

resource_group
required
string

Resource group name

role
required
string

Role identifier

required
object (Principal)

Role assignment principal

disabled
boolean

Role assignment is disabled or not

managed
boolean

Role assignment is managed or not

Responses
201

Role assignment response body

post/v1/orgs/{org}/role-assignments
Request samples
{
  • "identifier": "example_role_assignment",
  • "resource_group": "example_resource_group_identifier",
  • "role": "example_role_identifier",
  • "principal": {
    },
  • "disabled": false,
  • "managed": false
}
Response samples
{
  • "role-assignment": {
    },
  • "created": 1234567890,
  • "updated": 1234567890,
  • "harness_managaed": false
}

Retrieve a role assignment

Retrieves the information of the role assignment with the matching role assignment identifier.

Securityx-api-key
Request
path Parameters
role-assignment
required
string

Role assignment identifier

org
required
string

Organization identifier

header Parameters
Harness-Account
string

Identifier field of the account the resource is scoped to.

Responses
200

Role assignment response body

get/v1/orgs/{org}/role-assignments/{role-assignment}
Request samples
Response samples
{
  • "role-assignment": {
    },
  • "created": 1234567890,
  • "updated": 1234567890,
  • "harness_managaed": false
}

Delete a role assignment

Deletes the information of the role assignment with the matching role assignment identifier.

Securityx-api-key
Request
path Parameters
role-assignment
required
string

Role assignment identifier

org
required
string

Organization identifier

header Parameters
Harness-Account
string

Identifier field of the account the resource is scoped to.

Responses
200

Role assignment response body

delete/v1/orgs/{org}/role-assignments/{role-assignment}
Request samples
Response samples
{
  • "role-assignment": {
    },
  • "created": 1234567890,
  • "updated": 1234567890,
  • "harness_managaed": false
}