Invite

This contains APIs related to Invite as defined in Harness

Gets an Invite by either Invite Id or JwtToken

Request
Security:
ApiKey (readwrite)
query Parameters
inviteId
string

Invitation Id

jwttoken
string

JWT Token

Responses
400

Bad Request

500

Internal server error

default

Returns the Invite having either InviteId or JwtToken as specified in request

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",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

List all the Invites for a Project or Organization

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity

orgIdentifier
string

Organization Identifier for the Entity

projectIdentifier
string

Project Identifier for the Entity

pageIndex
integer <int32>
Default: 0

Indicates the number of pages. Results for these pages will be retrieved.

pageSize
integer <int32>
Default: 50

The number of the elements to fetch

Array of objects (SortOrder)

Sort criteria for the elements.

Responses
400

Bad Request

500

Internal server error

default

Paginated list of Invites

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=%5Bobject%20Object%5D' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Send a user Invite to either Project or Organization

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity

orgIdentifier
string

Organization Identifier for the Entity

projectIdentifier
string

Project Identifier for the Entity

Request Body schema:

Details of the Invite to create

users
Array of strings [ 0 .. 100 ] items
Array of objects (RoleBinding)
inviteType
string
Enum: "USER_INITIATED_INVITE" "ADMIN_INITIATED_INVITE" "SCIM_INITIATED_INVITE"
userGroups
Array of strings
Responses
400

Bad Request

500

Internal server error

default

Returns the Invite Operation Response

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

List of all the Invites pending users

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity

orgIdentifier
string

Organization Identifier for the Entity

projectIdentifier
string

Project Identifier for the Entity

searchTerm
string

Search term

pageIndex
integer <int32>
Default: 0

Indicates the number of pages. Results for these pages will be retrieved.

pageSize
integer <int32>
Default: 50

The number of the elements to fetch

Array of objects (SortOrder)

Sort criteria for the elements.

Request Body schema:
resourceGroupIdentifiers
Array of strings unique
roleIdentifiers
Array of strings unique
Responses
400

Bad Request

500

Internal server error

default

Paginated list of Pending Invites

post/ng/api/invites/aggregate
Request samples
{
  • "resourceGroupIdentifiers": [
    ],
  • "roleIdentifiers": [
    ]
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Resend the Invite email

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

Invite id

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity

Request Body schema:

Details of the Updated Invite

encryptionType
required
string
Enum: "LOCAL" "KMS" "GCP_KMS" "AWS_SECRETS_MANAGER" "AZURE_VAULT" "CYBERARK" "VAULT" "GCP_SECRETS_MANAGER" "CUSTOM" "VAULT_SSH"
orgIdentifier
string
projectIdentifier
string
identifier
required
string
required
object (SecretManagerMetadataRequestSpecDTO)
Responses
400

Bad Request

500

Internal server error

default

Returns the Invite

put/ng/api/invites/{inviteId}
Request samples
{
  • "encryptionType": "LOCAL",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "identifier": "string",
  • "spec": {
    }
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Delete an Invite by Identifier

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

Invite Id

Responses
400

Bad Request

500

Internal server error

default

Returns either empty value of Deleted Invite

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
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}