user-groups

Check if the user is part of the user group

Request
Security:
ApiKey (readwrite)
path Parameters
identifier
required
string
userIdentifier
required
string
query Parameters
accountIdentifier
required
string
orgIdentifier
string
projectIdentifier
string
Responses
200

successful operation

400

Bad Request

403

Unauthorized

500

Internal server error

get/ng/api/user-groups/{identifier}/member/{userIdentifier}
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/user-groups/:identifier/member/:userIdentifier?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": true,
  • "metaData": { },
  • "correlationId": "string"
}

Add a user to the user group

Request
Security:
ApiKey (readwrite)
path Parameters
identifier
required
string
userIdentifier
required
string
query Parameters
accountIdentifier
required
string
orgIdentifier
string
projectIdentifier
string
Responses
200

successful operation

400

Bad Request

403

Unauthorized

500

Internal server error

put/ng/api/user-groups/{identifier}/member/{userIdentifier}
Request samples
curl -i -X PUT \
  'https://app.harness.io/gateway/ng/api/user-groups/:identifier/member/:userIdentifier?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Remove a user from the user group

Request
Security:
ApiKey (readwrite)
path Parameters
identifier
required
string
userIdentifier
required
string
query Parameters
accountIdentifier
required
string
orgIdentifier
string
projectIdentifier
string
Responses
200

successful operation

400

Bad Request

403

Unauthorized

500

Internal server error

delete/ng/api/user-groups/{identifier}/member/{userIdentifier}
Request samples
curl -i -X DELETE \
  'https://app.harness.io/gateway/ng/api/user-groups/:identifier/member/:userIdentifier?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Link to SAML group

Request
Security:
ApiKey (readwrite)
path Parameters
userGroupId
required
string
samlId
required
string
query Parameters
accountIdentifier
required
string
orgIdentifier
string
projectIdentifier
string
Request Body schema:
samlGroupName
string
Responses
200

successful operation

400

Bad Request

403

Unauthorized

500

Internal server error

put/ng/api/user-groups/{userGroupId}/link/saml/{samlId}
Request samples
{
  • "samlGroupName": "string"
}
Response samples
{
  • "metaData": {
    },
  • "resource": {
    },
  • "responseMessages": [
    ]
}

API to unlink the harness user group from SSO group

Request
Security:
ApiKey (readwrite)
path Parameters
userGroupId
required
string
query Parameters
retainMembers
boolean
accountIdentifier
required
string
orgIdentifier
string
projectIdentifier
string
Responses
200

successful operation

400

Bad Request

403

Unauthorized

500

Internal server error

put/ng/api/user-groups/{userGroupId}/unlink
Request samples
curl -i -X PUT \
  'https://app.harness.io/gateway/ng/api/user-groups/:userGroupId/unlink?retainMembers=true&accountIdentifier=string&orgIdentifier=string&projectIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "metaData": {
    },
  • "resource": {
    },
  • "responseMessages": [
    ]
}

List users in a user group

Request
Security:
ApiKey (readwrite)
path Parameters
identifier
required
string
query Parameters
accountIdentifier
required
string
orgIdentifier
string
projectIdentifier
string
pageIndex
integer <int32>
Default: 0
pageSize
integer <int32> <= 100
Default: 50
sortOrders
Array of strings
Request Body schema:
searchTerm
string
identifiers
Array of strings unique
parentFilter
string
Enum: "NO_PARENT_SCOPES" "INCLUDE_PARENT_SCOPES" "STRICTLY_PARENT_SCOPES"
Responses
200

successful operation

400

Bad Request

403

Unauthorized

500

Internal server error

post/ng/api/user-groups/{identifier}/users
Request samples
{
  • "searchTerm": "string",
  • "identifiers": [
    ],
  • "parentFilter": "NO_PARENT_SCOPES"
}
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Get a User Group

Request
Security:
ApiKey (readwrite)
path Parameters
identifier
required
string
query Parameters
accountIdentifier
string
orgIdentifier
string
projectIdentifier
string
Responses
200

successful operation

400

Bad Request

403

Unauthorized

500

Internal server error

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

Delete a User Group

Request
Security:
ApiKey (readwrite)
path Parameters
identifier
required
string
query Parameters
accountIdentifier
string
orgIdentifier
string
projectIdentifier
string
Responses
200

successful operation

400

Bad Request

403

Unauthorized

500

Internal server error

delete/ng/api/user-groups/{identifier}
Request samples
curl -i -X DELETE \
  'https://app.harness.io/gateway/ng/api/user-groups/:identifier?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Get User Group List

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
Responses
200

successful operation

400

Bad Request

403

Unauthorized

500

Internal server error

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

Update a User Group

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
string
orgIdentifier
string
projectIdentifier
string
Request Body schema:
accountIdentifier
string
orgIdentifier
string
projectIdentifier
string
identifier
required
string
name
required
string
users
Array of strings
Array of objects (NotificationSettingConfigDTO)
linkedSsoId
string
linkedSsoDisplayName
string
ssoGroupId
string
ssoGroupName
string
description
string [ 0 .. 1024 ] characters
object
ssoLinked
boolean
Responses
200

successful operation

400

Bad Request

403

Unauthorized

500

Internal server error

put/ng/api/user-groups
Request samples
{
  • "accountIdentifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "identifier": "string",
  • "name": "string",
  • "users": [
    ],
  • "notificationConfigs": [
    ],
  • "linkedSsoId": "string",
  • "linkedSsoDisplayName": "string",
  • "ssoGroupId": "string",
  • "ssoGroupName": "string",
  • "description": "string",
  • "tags": {
    },
  • "ssoLinked": true
}
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Create a User Group

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
string
projectIdentifier
string
Request Body schema:
accountIdentifier
string
orgIdentifier
string
projectIdentifier
string
identifier
required
string
name
required
string
users
Array of strings
Array of objects (NotificationSettingConfigDTO)
linkedSsoId
string
linkedSsoDisplayName
string
ssoGroupId
string
ssoGroupName
string
description
string [ 0 .. 1024 ] characters
object
ssoLinked
boolean
Responses
200

successful operation

400

Bad Request

403

Unauthorized

500

Internal server error

post/ng/api/user-groups
Request samples
{
  • "accountIdentifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "identifier": "string",
  • "name": "string",
  • "users": [
    ],
  • "notificationConfigs": [
    ],
  • "linkedSsoId": "string",
  • "linkedSsoDisplayName": "string",
  • "ssoGroupId": "string",
  • "ssoGroupName": "string",
  • "description": "string",
  • "tags": {
    },
  • "ssoLinked": true
}
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Get Batch User Group List

Request
Security:
ApiKey (readwrite)
Request Body schema:
databaseIdFilter
Array of strings unique
identifierFilter
Array of strings unique
userIdentifierFilter
Array of strings unique
accountIdentifier
string
orgIdentifier
string
projectIdentifier
string
searchTerm
string
Responses
200

successful operation

400

Bad Request

403

Unauthorized

500

Internal server error

post/ng/api/user-groups/batch
Request samples
{
  • "databaseIdFilter": [
    ],
  • "identifierFilter": [
    ],
  • "userIdentifierFilter": [
    ],
  • "accountIdentifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "searchTerm": "string"
}
Response samples
{
  • "status": "SUCCESS",
  • "data": [
    ],
  • "metaData": { },
  • "correlationId": "string"
}