Invite

This contains APIs related to Invite as defined in Harness

Delete Invite

Delete an Invite by Identifier

SecurityApiKey
Request
path Parameters
inviteId
required
string

Invite Id

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Responses
400

Bad Request

500

Internal server error

default

Returns either empty value of Deleted Invite

delete/ng/api/invites/{inviteId}
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get Invite

Gets an Invite by either Invite Id or JwtToken

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

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

Get pending users

List of all the pending users in a scope

SecurityApiKey
Request
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

Page Index of the results to fetch.Default Value: 0

pageSize
integer <int32> <= 100
Default: 50

Results per page(max 100)Default Value: 50

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": [
    ]
}

List Invites

List all the Invites for a Project or Organization

SecurityApiKey
Request
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

Page Index of the results to fetch.Default Value: 0

pageSize
integer <int32> <= 100
Default: 50

Results per page(max 100)Default Value: 50

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

Resend invite

Resend the invite email

SecurityApiKey
Request
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

This specifies the type of encryption used by the Secret Manager to encrypt Secrets.

Enum: "LOCAL" "KMS" "GCP_KMS" "AWS_SECRETS_MANAGER" "AZURE_VAULT" "VAULT" "GCP_SECRETS_MANAGER" "CUSTOM" "VAULT_SSH" "CUSTOM_NG"
orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

identifier
required
string

Identifier of the SecretManager metadata.

required
object (SecretManagerMetadataRequestSpecDTO)

Spec of the Secret Manager.

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": [
    ]
}