Check if the user is part of the user group in an account/org/project
Bad Request
Internal server error
Return true/false based on whether the user is part of the user group
{- "status": "SUCCESS",
- "code": "DEFAULT_ERROR_CODE",
- "message": "string",
- "correlationId": "string",
- "errors": [
- {
- "fieldId": "string",
- "error": "string"
}
]
}
Add a user to the user group in an account/org/project
Bad Request
Internal server error
Returns the updated user group after user addition
{- "status": "SUCCESS",
- "code": "DEFAULT_ERROR_CODE",
- "message": "string",
- "correlationId": "string",
- "errors": [
- {
- "fieldId": "string",
- "error": "string"
}
]
}
Remove a user from the user group in an account/org/project
Bad Request
Internal server error
Returns the updated user group after user removal
{- "status": "SUCCESS",
- "code": "DEFAULT_ERROR_CODE",
- "message": "string",
- "correlationId": "string",
- "errors": [
- {
- "fieldId": "string",
- "error": "string"
}
]
}
Copy a User Group in an account/org/project
List of scopes
Bad Request
Internal server error
Returns whether the copy was successful
[- {
- "accountIdentifier": "string",
- "orgIdentifier": "string",
- "projectIdentifier": "string"
}
]
{- "status": "SUCCESS",
- "code": "DEFAULT_ERROR_CODE",
- "message": "string",
- "correlationId": "string",
- "errors": [
- {
- "fieldId": "string",
- "error": "string"
}
]
}
List User Groups
Bad Request
Internal server error
Returns the paginated list of the User Groups.
{- "status": "SUCCESS",
- "code": "DEFAULT_ERROR_CODE",
- "message": "string",
- "correlationId": "string",
- "errors": [
- {
- "fieldId": "string",
- "error": "string"
}
]
}
Update a User Group in an account/org/project
User Group entity with the updates
Bad Request
Internal server error
Returns the successfully updated User Group
{- "accountIdentifier": "string",
- "orgIdentifier": "string",
- "projectIdentifier": "string",
- "identifier": "string",
- "name": "string",
- "users": [
- "string"
], - "notificationConfigs": [
- {
- "type": "EMAIL"
}
], - "isSsoLinked": true,
- "linkedSsoId": "string",
- "linkedSsoDisplayName": "string",
- "ssoGroupId": "string",
- "ssoGroupName": "string",
- "linkedSsoType": "string",
- "externallyManaged": true,
- "description": "string",
- "tags": {
- "property1": "string",
- "property2": "string"
}, - "harnessManaged": true,
- "ssoLinked": true
}
{- "status": "SUCCESS",
- "code": "DEFAULT_ERROR_CODE",
- "message": "string",
- "correlationId": "string",
- "errors": [
- {
- "fieldId": "string",
- "error": "string"
}
]
}
Create a User Group in an account/org/project
User Group entity to be created
Bad Request
Internal server error
Returns the successfully created User Group
{- "accountIdentifier": "string",
- "orgIdentifier": "string",
- "projectIdentifier": "string",
- "identifier": "string",
- "name": "string",
- "users": [
- "string"
], - "notificationConfigs": [
- {
- "type": "EMAIL"
}
], - "isSsoLinked": true,
- "linkedSsoId": "string",
- "linkedSsoDisplayName": "string",
- "ssoGroupId": "string",
- "ssoGroupName": "string",
- "linkedSsoType": "string",
- "externallyManaged": true,
- "description": "string",
- "tags": {
- "property1": "string",
- "property2": "string"
}, - "harnessManaged": true,
- "ssoLinked": true
}
{- "status": "SUCCESS",
- "code": "DEFAULT_ERROR_CODE",
- "message": "string",
- "correlationId": "string",
- "errors": [
- {
- "fieldId": "string",
- "error": "string"
}
]
}
Get a User Group in an account/org/project
Bad Request
Internal server error
Returns the successfully fetched User Group
{- "status": "SUCCESS",
- "code": "DEFAULT_ERROR_CODE",
- "message": "string",
- "correlationId": "string",
- "errors": [
- {
- "fieldId": "string",
- "error": "string"
}
]
}
Delete User Group
Bad Request
Internal server error
Returns the successfully deleted User Group
{- "status": "SUCCESS",
- "code": "DEFAULT_ERROR_CODE",
- "message": "string",
- "correlationId": "string",
- "errors": [
- {
- "fieldId": "string",
- "error": "string"
}
]
}