SCIM

This contains APIs related to SCIM provisioning

getUser

Request
Security:
ApiKey (readwrite)
path Parameters
userIdentifier
required
string
accountIdentifier
required
string
Responses
400

Bad Request

500

Internal server error

get/ng/api/scim/account/{accountIdentifier}/Users/{userIdentifier}
Request samples
curl -i -X GET \
  https://app.harness.io/gateway/ng/api/scim/account/:accountIdentifier/Users/:userIdentifier \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

updateUser_1

Request
Security:
ApiKey (readwrite)
path Parameters
userIdentifier
required
string
accountIdentifier
required
string
Request Body schema:
schemas
Array of strings unique
userName
string
displayName
string
active
boolean
object (JsonNode)
object (JsonNode)
object (JsonNode)
object (JsonNode)
object (JsonNode)
id
string
externalId
string
object (JsonNode)
Responses
400

Bad Request

500

Internal server error

put/ng/api/scim/account/{accountIdentifier}/Users/{userIdentifier}
Request samples
{
  • "schemas": [
    ],
  • "userName": "string",
  • "displayName": "string",
  • "active": true,
  • "emails": {
    },
  • "roles": {
    },
  • "name": {
    },
  • "groups": {
    },
  • "password": {
    },
  • "id": "string",
  • "externalId": "string",
  • "meta": {
    }
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

deleteUser

Request
Security:
ApiKey (readwrite)
path Parameters
userIdentifier
required
string
accountIdentifier
required
string
Responses
400

Bad Request

500

Internal server error

delete/ng/api/scim/account/{accountIdentifier}/Users/{userIdentifier}
Request samples
curl -i -X DELETE \
  https://app.harness.io/gateway/ng/api/scim/account/:accountIdentifier/Users/:userIdentifier \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

updateUser

Request
Security:
ApiKey (readwrite)
path Parameters
accountIdentifier
required
string
userIdentifier
required
string
Request Body schema:
required
Array of objects (PatchOperation)
id
string
externalId
string
object (JsonNode)
schemas
required
Array of strings unique
Responses
400

Bad Request

500

Internal server error

patch/ng/api/scim/account/{accountIdentifier}/Users/{userIdentifier}
Request samples
{
  • "Operations": [
    ],
  • "id": "string",
  • "externalId": "string",
  • "meta": {
    },
  • "schemas": [
    ]
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

searchUser

Request
Security:
ApiKey (readwrite)
path Parameters
accountIdentifier
required
string
query Parameters
filter
string
count
integer <int32>
startIndex
integer <int32>
Responses
400

Bad Request

500

Internal server error

get/ng/api/scim/account/{accountIdentifier}/Users
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/scim/account/:accountIdentifier/Users?filter=string&count=0&startIndex=0' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

createUser

Request
Security:
ApiKey (readwrite)
path Parameters
accountIdentifier
required
string
Request Body schema:
schemas
Array of strings unique
userName
string
displayName
string
active
boolean
object (JsonNode)
object (JsonNode)
object (JsonNode)
object (JsonNode)
object (JsonNode)
id
string
externalId
string
object (JsonNode)
Responses
400

Bad Request

500

Internal server error

post/ng/api/scim/account/{accountIdentifier}/Users
Request samples
{
  • "schemas": [
    ],
  • "userName": "string",
  • "displayName": "string",
  • "active": true,
  • "emails": {
    },
  • "roles": {
    },
  • "name": {
    },
  • "groups": {
    },
  • "password": {
    },
  • "id": "string",
  • "externalId": "string",
  • "meta": {
    }
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}