Harness

Invite

This contains APIs related to Invite as defined in Harness

Resend invite

Resend the invite email

Securityx-api-key
Request
path Parameters
inviteId
required
string

Invite id

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema:
required

Details of the Updated Invite

id
string

Identifier of the Invite.

name
string

Name of the Invite.

email
required
string

Email Id associated with the user to be invited.

accountIdentifier
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

Array of objects (RoleBinding)

Role bindings to be associated with the invited users.

userGroups
Array of strings

List of the userGroups in the invite.

inviteType
required
string

Specifies the invite type.

Enum: "USER_INITIATED_INVITE" "ADMIN_INITIATED_INVITE" "SCIM_INITIATED_INVITE"
approved
boolean

Specifies whether or not the invite is approved. By default this value is set to false.

Responses
400

Bad Request

500

Internal server error

default

Returns the Invite

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

Delete Invite

Delete an Invite by Identifier

Securityx-api-key
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


Securityx-api-key 
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": [
    ]
}
List Invites
List all the Invites for a Project or Organization


Securityx-api-key 
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.


 
pageToken
string
Page Token of the next results to fetch.Default Value: ''


 
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": [
    ]
}
Get pending users
List of all the pending users in a scope


Securityx-api-key 
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.


 
pageToken
string
Page Token of the next results to fetch.Default Value: ''


 
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": [
    ]
}
➔ Next to IP Allowlist [Beta]