API cookbook: EnvironmentUser
This API cookbook recipe describes how to configure your environment user using the Delphix Engine API.
CODE
{
"root": "/resources/json/delphix/environment/user",
"name": "EnvironmentUser",
"description": "The representation of an environment user object.",
"extends": {
"$ref": "/delphix-user-object.json"
},
"nameParent": "environment",
"properties": {
"credential": {
"type": "object",
"$ref": "/delphix-credential.json",
"description": "The credential for the environment user.",
"create": "required",
"update": "optional",
"properties": {
"type": {
"type": "string",
"description": "Object type.",
"required": true,
"format": "type",
"default": "PasswordCredential"
}
}
},
"environment": {
"type": "string",
"description": "A reference to the associated environment.",
"format": "objectReference",
"referenceTo": "/delphix-source-environment.json",
"create": "optional"
},
"groupId": {
"type": "integer",
"description": "Group ID of the user.",
"create": "optional",
"update": "optional",
"minimum": 0,
"maximum": 4294967295
},
"userId": {
"type": "integer",
"description": "User ID of the user.",
"create": "optional",
"update": "optional",
"minimum": 0,
"maximum": 4294967295
}
},
"create": {
"description": "Create a new EnvironmentUser object.",
"payload" : {
"type": "object",
"$ref": "/delphix-source-environment-user.json"
},
"return": {
"type": "string",
"format": "objectReference",
"referenceTo": "/delphix-source-environment-user.json"
}
},
"read": {
"description": "Retrieve the specified EnvironmentUser object.",
"return": {
"type": "object",
"$ref": "/delphix-source-environment-user.json"
}
},
"update": {
"description": "Update the specified EnvironmentUser object.",
"payload": {
"type": "object",
"$ref": "/delphix-source-environment-user.json"
}
},
"delete": {
"payload": {
"type": "object",
"$ref": "/delphix-delete-parameters.json",
"required": false
},
"description" : "Delete the specified EnvironmentUser object."
},
"list": {
"description": "Returns the list of all environment users in the system.",
"parameters": {
"environment": {
"type": "string",
"description": "Limit results to users within the given environment.",
"format": "objectReference",
"referenceTo": "/delphix-source-environment.json",
"mapsTo": "environment"
}
}
"return": {
"type": "array",
"items": {
"type": "object",
"$ref": "/delphix-source-environment-user.json"
}
}
}
}