invites

Resend invite mail

Request
Security:
ApiKey (readwrite)
path Parameters
inviteId
required
string
query Parameters
accountIdentifier
string
Request Body schema:
id
required
string
name
required
string
email
required
string
accountIdentifier
required
string
orgIdentifier
string
projectIdentifier
string
required
Array of objects (RoleBinding)
userGroups
Array of strings
inviteType
required
string
Enum: "USER_INITIATED_INVITE" "ADMIN_INITIATED_INVITE"
approved
boolean
Responses
200

successful operation

400

Bad Request

500

Internal server error

put/ng/api/invites/{inviteId}
Request samples
{
  • "id": "string",
  • "name": "string",
  • "email": "string",
  • "accountIdentifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "roleBindings": [
    ],
  • "userGroups": [
    ],
  • "inviteType": "USER_INITIATED_INVITE",
  • "approved": true
}
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Delete a invite for the specified project/organization

Request
Security:
ApiKey (readwrite)
path Parameters
inviteId
required
string
Responses
200

successful operation

400

Bad Request

500

Internal server error

delete/ng/api/invites/{inviteId}
Request samples
curl -i -X DELETE \
  https://app.harness.io/gateway/ng/api/invites/:inviteId \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Get all invites for the queried project/organization

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
string
projectIdentifier
string
pageIndex
integer <int32>
Default: 0
pageSize
integer <int32> <= 100
Default: 50
sortOrders
Array of strings
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/invites
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/invites?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&pageIndex=0&pageSize=50&sortOrders=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Add a new invite for the specified project/organizationDeprecated

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
string
projectIdentifier
string
Request Body schema:
users
required
Array of strings [ 0 .. 100 ] items
required
Array of objects (RoleBinding)
inviteType
required
string
Enum: "USER_INITIATED_INVITE" "ADMIN_INITIATED_INVITE"
userGroups
Array of strings
Responses
200

successful operation

400

Bad Request

500

Internal server error

post/ng/api/invites
Request samples
{
  • "users": [
    ],
  • "roleBindings": [
    ],
  • "inviteType": "USER_INITIATED_INVITE",
  • "userGroups": [
    ]
}
Response samples
{
  • "status": "SUCCESS",
  • "data": [
    ],
  • "metaData": { },
  • "correlationId": "string"
}

Get a page of pending users for access control

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
string
projectIdentifier
string
searchTerm
string
pageIndex
integer <int32>
Default: 0
pageSize
integer <int32> <= 100
Default: 50
sortOrders
Array of strings
Request Body schema:
resourceGroupIdentifiers
Array of strings unique
roleIdentifiers
Array of strings unique
Responses
200

successful operation

400

Bad Request

500

Internal server error

post/ng/api/invites/aggregate
Request samples
{
  • "resourceGroupIdentifiers": [
    ],
  • "roleIdentifiers": [
    ]
}
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Get invite

Request
Security:
ApiKey (readwrite)
query Parameters
inviteId
string
jwttoken
string
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/invites/invite
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/invites/invite?inviteId=string&jwttoken=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}