MidPoint

https://docs.evolveum.com
Admin
MidPoint is an open source identity governance and administration (IGA) platform that manages...
Tokens:3,532,831
Snippets:23,630
Trust Score:9.6
Update:2 days ago
Show doc for...
Tokens:
Raw
### Sample output of the start command

Source: https://docs.evolveum.com/midpoint/get-started/quick-start

Example output from running the quickstart script with the 'start' argument. It shows the password policy prompt, the generated password, and the deployment progress. The output includes the web GUI address, username, and initial password.

```bash
$ ./midpoint-quickstart-4.9.3.sh start
Enter your new admin password.
The password must:
 - be at least 8 characters long,
 - contain one number,
 - contain one upper case,
 - contain one lower case letter
For automatically generated password in midPoint, leave blank and press ENTER.

4ToBeamUpEnergize
Fresh installation  -  creating home folder and setting up midPoint...
[+] Running 5/5
 ✔ Network midpoint-quickstart-mzjtbs_net                      Created     0.0s
 ✔ Volume "midpoint-quickstart-mzjtbs_midpoint_data"           Created     0.0s
 ✔ Container midpoint-quickstart-mzjtbs-midpoint_data-1        Healthy     6.8s
 ✔ Container midpoint-quickstart-mzjtbs-data_init-1            Exited      6.8s
 ✔ Container midpoint-quickstart-mzjtbs-midpoint_server-1      Healthy     21.8s

Starting midPoint...
To access the WEB GUI go to: http://localhost:8080/midpoint/
Username: administrator
Initial password: 4ToBeamUpEnergize (recommended to change in midPoint for increased security)
```

--------------------------------

### Install 389-ds on Ubuntu

Source: https://docs.evolveum.com/connectors/resources/ldap/389ds

Commands to install and set up 389 Directory Server on Ubuntu. Use 'dc=example,dc=com' as the suffix during setup.

```bash
apt-get install 389-ds
setup-ds
```

--------------------------------

### Properties file example

Source: https://docs.evolveum.com/midpoint/tools/studio/usage

Shows the simple format of a properties file for storing non-sensitive properties. Property names cannot contain spaces, tabs, or '=', but values can contain '='. Comments are allowed with '#'.

```properties
ldapHost=server.example.com
ldapPort=389
ldapBaseContext=dc=example,dc=com
...
```

--------------------------------

### Method chaining example: ListUsersPage search and click

Source: https://docs.evolveum.com/midpoint/tools/schrodinger/writing-tests-with-schrodinger

Shows a fluent chain of method calls on a ListUsersPage instance to search for a user by name and verify activation state. Uses indentation to align calls on the same component and the and() method to return to the table.

```java
ListUsersPage usersPage = basicPage.listUsers();
Assert.assertTrue
        (
        usersPage // "List users" page
            .table() // The table containing the list of users
                .search() // The "search" component of the table
                    .byName() // The "popover" component visible after clicking the "name" input box
                    .inputValue(TEST_USER_TITIAN_NAME) // The "popover" component
                .updateSearch() // The "search" component of the table
            .and() // The table containing the list of users
                .clickByName("titian") // The page of the user
                  .isActivationState("Enabled")
        );
```

--------------------------------

### Macro expansion example in resource XML

Source: https://docs.evolveum.com/midpoint/tools/studio/usage

Shows how to use macro expansions like $(ldapPort) in a resource XML to avoid hard-coded properties. The properties used are ldapHost, ldapPort, ldapBaseContext, ldapAdmin, and ldapPassword.

```xml
<resource>
   ...
   <connectorConfiguration>
      <icfc:configurationProperties xmlns:icfcldap="http://midpoint.evolveum.com/xml/ns/public/connector/icf-1/bundle/com.evolveum.polygon.connector-ldap/com.evolveum.polygon.connector.ldap.LdapConnector">
         <icfcldap:port>$(ldapPort)</icfcldap:port>
         <icfcldap:host>$(ldapHost)</icfcldap:host>
         <icfcldap:baseContext>$(ldapBaseContext)</icfcldap:baseContext>
         <icfcldap:bindDn>$(ldapAdmin)</icfcldap:bindDn>
         <icfcldap:bindPassword>
            <t:clearValue>$(ldapPassword)</t:clearValue>
         </icfcldap:bindPassword>
         <icfcldap:pagingStrategy>auto</icfcldap:pagingStrategy>
         <icfcldap:vlvSortAttribute>entryUUID</icfcldap:vlvSortAttribute>
         <icfcldap:operationalAttributes>ds-pwp-account-disabled</icfcldap:operationalAttributes>
         <icfcldap:operationalAttributes>isMemberOf</icfcldap:operationalAttributes>
      </icfc:configurationProperties>
  ...
  </connectorConfiguration>
  ...
</resource>
```

--------------------------------

### Maven build command: mvn clean install -DskipTests -P -dist

Source: https://docs.evolveum.com/midpoint/tools/intellij-idea

Run this Maven command at least once to build the project. The -P -dist flag disables the dist profile.

```bash
mvn clean install -DskipTests -P -dist
```

--------------------------------

### GET Object Response Example

Source: https://docs.evolveum.com/midpoint/reference/support-4.10/interfaces/rest/operations/get-op-rest

Example response body for a GET operation that fetches an object, showing identity data and metadata.

```APIDOC
## GET Object Response Example

### Description
This example shows the response body for a GET operation that retrieves an object. It contains identity data and metadata, with some technical information removed.

### Response Example
```json
{
  "user" : {
    "oid" : "00000000-0000-0000-0000-000000000002",
    "name" : "administrator",
    "indestructible" : true,
    "assignment" : [ {
      "@id" : 1,
      "identifier" : "superuserRole",
      "targetRef" : {
        "oid" : "00000000-0000-0000-0000-000000000004",
        "relation" : "org:default",
        "type" : "c:RoleType"
      },
      "activation" : {
        "effectiveStatus" : "enabled"
      }
    }, {
      "@id" : 2,
      "identifier" : "archetype",
      "targetRef" : {
        "oid" : "00000000-0000-0000-0000-000000000300",
        "relation" : "org:default",
        "type" : "c:ArchetypeType"
      },
      "activation" : {
        "effectiveStatus" : "enabled"
      }
    } ],
    "iteration" : 0,
    "iterationToken" : "",
    "archetypeRef" : {
      "oid" : "00000000-0000-0000-0000-000000000300",
      "relation" : "org:default",
      "type" : "c:ArchetypeType"
    },
    "roleMembershipRef" : [ {
      "oid" : "00000000-0000-0000-0000-000000000300",
      "relation" : "org:default",
      "type" : "c:ArchetypeType"
    }, {
      "oid" : "00000000-0000-0000-0000-000000000004",
      "relation" : "org:default",
      "type" : "c:RoleType"
    } ],
    "credentials" : {
      "password" : {
        "value" : {
          "clearValue" : "5ecr3t"
        }
      }
    },
    "fullName" : "midPoint Administrator",
    "givenName" : "midPoint",
    "familyName" : "Administrator"
  }
}
```
```

--------------------------------

### Make quickstart script executable

Source: https://docs.evolveum.com/midpoint/get-started/quick-start

Sets execute permissions on the downloaded script so it can be run.

```bash
chmod 744 midpoint-quickstart.sh
```

--------------------------------

### MP_ENTRY_POINT directory structure example

Source: https://docs.evolveum.com/midpoint/get-started/install/containers/customization

Shows the source and destination directory structures for the entry point example. Files with .done suffix are skipped, and new files are copied.

```text
/opt/entry-point
- post-initial-objects
  + user.xml
  - role.xml

/opt/midpoint/var
+ post-initial-objects
  - user.xml.done
```

--------------------------------

### Get Report object - example output (simplified)

Source: https://docs.evolveum.com/midpoint/reference/support-4.10/interfaces/rest/endpoints/reports

Example JSON response body for the GET request. Simplified and does not contain all possible properties of the report object type.

```json
{
	"report": {
		"oid": "4de173d5-4dff-4e4f-bfb8-47f951f26637",
		"version": "1",
		"name": "All error audit records in 24h",
		"description": "Report made from all audit records.",
		"metadata": {},
		"operationExecution": {},
		"assignment": {
			"@id": 1,
			"identifier": "archetype",
			"metadata": {},
			"targetRef": {
				"oid": "00000000-0000-0000-0000-000000000171",
				"relation": "org:default",
				"type": "c:ArchetypeType"
			}
		},
		"iteration": 0,
		"iterationToken": "",
		"archetypeRef": {
			"oid": "00000000-0000-0000-0000-000000000171",
			"relation": "org:default",
			"type": "c:ArchetypeType"
		},
		"roleMembershipRef": {
			"@metadata": {},
			"oid": "00000000-0000-0000-0000-000000000171",
			"relation": "org:default",
			"type": "c:ArchetypeType"
		},
		"objectCollection": {
			"collection": {
				"baseCollectionRef": {
					"collectionRef": {
						"oid": "00000000-0000-0000-0001-000000000004",
						"relation": "org:default",
						"type": "c:ObjectCollectionType"
					}
				}
			},
			"parameter": [
				{
					"@id": 2,
					"name": "outcome",
					"type": "#OperationResultStatusType",
					"display": {
						"label": {
							"orig": "outcome",
							"norm": "outcome",
							"translation": {
								"key": "AuditEventRecordType.outcome"
							}
						}
					}
				},
				{
					"@id": 3,
					"name": "eventType",
					"type": "#AuditEventTypeType",
					"display": {
						"label": {
							"orig": "eventType",
							"norm": "eventtype",
							"translation": {
								"key": "AuditEventRecordType.eventType"
							}
						}
					}
				},
				{
					"@id": 4,
					"name": "eventStage",
					"type": "#AuditEventStageType",
					"display": {
						"label": {
							"orig": "eventStage",
							"norm": "eventstage",
							"translation": {
								"key": "AuditEventRecordType.eventStage"
							}
						}
					}
				},
				{
					"@id": 5,
					"name": "from",
					"type": "#dateTime",
					"display": {
						"label": {
							"orig": "from",
							"norm": "from",
							"translation": {
								"key": "AuditPopupPanel.dateFrom"
							}
						}
					}
				},
				{
					"@id": 6,
					"name": "to",
					"type": "#dateTime",
					"display": {
						"label": {
							"orig": "to",
							"norm": "to",
							"translation": {
								"key": "AuditPopupPanel.dateTo"
							}
						}
					}
				},
				{
					"@id": 7,
					"name": "targetRef",
					"type": "c:ObjectReferenceType",
					"display": {
						"label": {
							"orig": "targetRef",
							"norm": "targetref",
							"translation": {
								"key": "AuditEventRecordType.targetRef"
							}
						}
					}
				},
				{
					"@id": 8,
					"name": "initiatorRef",
					"type": "c:ObjectReferenceType",
					"display": {
						"label": {
							"orig": "initiatorRef",
							"norm": "initiatorref",
							"translation": {
								"key": "AuditEventRecordType.initiatorRef"
							}
						}
					}
				}
			]
		}
	}
}
```

--------------------------------

### Run quickstart script with start argument

Source: https://docs.evolveum.com/midpoint/get-started/quick-start

Run the script with the 'start' argument to deploy a new midPoint instance. You will be prompted for an admin password that complies with the midPoint password policy, or you can press Enter for an automatically generated password. The script output provides the web address and login credentials.

```bash
./midpoint-quickstart.sh start
```

--------------------------------

### Get Role Example Output

Source: https://docs.evolveum.com/midpoint/reference/support-4.10/interfaces/rest/endpoints/roles

Simplified example response body for the Get Role operation. Some properties are removed for brevity; it does not contain all possible properties of the Role object type.

```json
{
	"role": {
		"oid": "00000000-0000-0000-0000-000000000008",
		"version": "1",
		"name": "End user",
		"description": "Role authorizing end users to log in, change their passwords and review assigned accounts. Note: This role definition is just an example. It should be tailored for each specific deployment.",
		"metadata": {
		},
		"operationExecution": {
		},
		"iteration": 0,
		"iterationToken": "",
		"activation": {
		},
		"authorization": [],
		"adminGuiConfiguration": {}
	}
}
```

--------------------------------

### Get Shadow Owner - Example Output

Source: https://docs.evolveum.com/midpoint/reference/support-4.10/interfaces/rest/operations/shadow-op-rest

Simplified JSON response for the 'Get Shadow owner' example. Some properties were removed to keep the output short; it does not contain all possible properties of this object type.

```json
{
  "user" : {
    "oid" : "a9885c61-c442-42d8-af34-8182a8653e3c",
    "version" : "",
    "name" : "Jack",
    "metadata" : {},
    "operationExecution" : [ {}, {} ],
    "assignment" : [ {}, {} ],
    "iteration" : 0,
    "iterationToken" : "",
    "roleMembershipRef" : [ {}, {} ],
    "linkRef" : {
      "oid" : "062ac29f-f296-4824-aeab-9a0feb9e8bd3",
      "relation" : "org:default",
      "type" : "c:ShadowType"
    },
    "activation" : {},
    "emailAddress" : "jack@evolveum.com",
    "credentials" : {},
    "givenName" : "Jack",
    "familyName" : "Sparrow"
  }
}
```

--------------------------------

### Example output of upgrade-installation command

Source: https://docs.evolveum.com/midpoint/reference/support-4.10/upgrade/upgrade-with-ninja

Shows the expected output when running the upgrade-installation command, including the installation directory and next steps.

```text
/opt/midpoint/bin/ninja.sh upgrade-installation --distribution-directory  /opt/midpoint/midpoint-upgrade-to-4.10/ --installation-directory /opt/midpoint/

[INFO]
[INFO] Starting upgrade installation
[INFO]
[INFO] Midpoint installation directory: /opt/midpoint
[INFO] Installation upgraded successfully
[INFO]
[INFO] Next step should be to update initial objects. You can use 'ninja initial-objects --dry-run' to review changes.
[INFO] Please see documentation and initial-objects command options for more information.
```

--------------------------------

### Example Output of Get Case for Employee assignment (JSON)

Source: https://docs.evolveum.com/midpoint/reference/support-4.10/interfaces/rest/endpoints/cases

Simplified JSON response for the get case example. Some properties are removed to keep the output short; it does not contain all possible properties of the CaseType.

```json
{
  "case" : {
    "oid" : "3091ccc5-f3f6-4a06-92b5-803afce1ce57",
    "version" : "1",
    "name" : {
      "orig" : "Assigning role \"Basic Employee\" to user \"Jack\"",
      "norm" : "assigning role basic employee to user jack",
      "translation" : {
        "key" : "DefaultPolicyConstraint.Short.assignmentModification.toBeAdded",
        "argument" : [ {
          "translation" : {
            "key" : "ObjectSpecification",
            "argument" : [ {
              "translation" : {
                "key" : "ObjectTypeLowercase.RoleType",
                "fallback" : "RoleType"
              }
            }, {
              "value" : "Basic Employee"
            } ]
          }
        }, {
          "translation" : {
            "key" : "ObjectSpecification",
            "argument" : [ {
              "translation" : {
                "key" : "ObjectTypeLowercase.UserType",
                "fallback" : "UserType"
              }
            }, {
              "value" : "Jack"
            } ]
          }
        } ]
      }
    },
    "metadata" : {},
    "assignment" : {
      "@id" : 1,
      "targetRef" : {
        "oid" : "00000000-0000-0000-0000-000000000342",
        "relation" : "org:default",
        "type" : "c:ArchetypeType",
        "targetName" : "Approval case"
      }
    },
    "archetypeRef" : {
      "oid" : "00000000-0000-0000-0000-000000000342",
      "relation" : "org:default",
      "type" : "c:ArchetypeType",
      "targetName" : "Approval case"
    },
    "parentRef" : {
      "oid" : "dae84d15-ba06-44f2-81ec-45a35bd7bc8e",
      "relation" : "org:default",
      "type" : "c:CaseType",
      "targetName" : "Approving and executing change of user \"Jack\" (started Feb 22, 2024, 11:41:53 AM)"
    },
    "objectRef" : {
      "oid" : "a9885c61-c442-42d8-af34-8182a8653e3c",
      "relation" : "org:default",
      "type" : "c:UserType",
      "targetName" : "Jack"
    },
    "targetRef" : {
      "oid" : "96262f4f-053a-4b0b-8901-b3ec01e3509c",
      "relation" : "org:default",
      "type" : "c:RoleType",
      "targetName" : "employee"
    },
    "requestorRef" : {
      "oid" : "00000000-0000-0000-0000-000000000002",
      "relation" : "org:default",
      "type" : "c:UserType",
      "targetName" : "administrator"
    },
    "state" : "open",
    "event" : {
      "@type" : "c:CaseCreationEventType",
      "@id" : 3,
      "timestamp" : "2024-02-22T11:41:53.515+01:00",
      "initiatorRef" : {
        "oid" : "00000000-0000-0000-0000-000000000002",
        "relation" : "org:default",
        "type" : "c:UserType",
        "targetName" : "administrator"
      }
    },
    "workItem" : {
      "@id" : 4,
      "name" : {
        "orig" : "Assigning role \"Basic Employee\" to user \"Jack\"",
        "norm" : "assigning role basic employee to user jack",
        "translation" : {
          "key" : "DefaultPolicyConstraint.Short.assignmentModification.toBeAdded",
          "argument" : [ {
            "translation" : {
              "key" : "ObjectSpecification",
              "argument" : [ {
                "translation" : {
                  "key" : "ObjectTypeLowercase.RoleType",
                  "fallback" : "RoleType"
                }
              }, {
                "value" : "Basic Employee"
              } ]
            }
          }, {
            "translation" : {
              "key" : "ObjectSpecification",
              "argument" : [ {
                "translation" : {
                  "key" : "ObjectTypeLowercase.UserType",
                  "fallback" : "UserType"
                }
              }, {
                "value" : "Jack"
              } ]
            }
          } ]
        }
      }
    }
  }
}
```

--------------------------------

### Start the training environment

Source: https://docs.evolveum.com/midpoint/methodology/first-steps-training/bonus-points/reset-training-environment

Run this command after stopping the containers to start the whole training environment anew. Note the typo 'compse' in the source; use it as shown.

```bash
docker compse up -d
```

--------------------------------

### Example output of Get Resource object

Source: https://docs.evolveum.com/midpoint/reference/support-4.10/interfaces/rest/endpoints/resources

Simplified JSON response for the Get Resource object example. Shows the structure of a resource object with connector configuration, schema handling, and capabilities. Not all properties are included.

```json
{
  "resource" : {
    "oid" : "ef2bc95b-76e0-59e2-86d6-9999cccccccc",
    "version" : "1",
    "name" : "Test CSV: username",
    "description" : "Simple CSV resource that is using single identifier (username)",
    "metadata" : {},
    "operationExecution" : {},
    "iteration" : 0,
    "iterationToken" : "",
    "connectorRef" : {
      "oid" : "01aa0a9e-dfe0-47c8-8fca-4446894a348c",
      "relation" : "org:default",
      "type" : "c:ConnectorType",
      "filter" : {
        "equal" : {
          "path" : "c:connectorType",
          "value" : "com.evolveum.polygon.connector.csv.CsvConnector"
        }
      }
    },
    "connectorConfiguration" : {
      "@ns" : "http://midpoint.evolveum.com/xml/ns/public/connector/icf-1/connector-schema-3",
      "configurationProperties" : {
        "@ns" : "http://midpoint.evolveum.com/xml/ns/public/connector/icf-1/bundle/com.evolveum.polygon.connector-csv/com.evolveum.polygon.connector.csv.CsvConnector",
        "multivalueDelimiter" : ";",
        "fieldDelimiter" : ",",
        "filePath" : "target/midpoint.csv",
        "encoding" : "utf-8",
        "passwordAttribute" : "password",
        "uniqueAttribute" : "username"
      }
    },
    "schemaHandling" : {
      "objectType" : {
        "@id" : 1,
        "displayName" : "Default Account",
        "default" : true,
        "objectClass" : "ri:AccountObjectClass",
        "attribute" : [ {
          "@id" : 2,
          "ref" : "ri:username",
          "outbound" : {
            "source" : {
              "path" : "$user/name"
            }
          }
        }, {
          "@id" : 3,
          "ref" : "ri:firstname",
          "outbound" : {
            "source" : {
              "path" : "$user/givenName"
            }
          }
        }, {
          "@id" : 4,
          "ref" : "ri:lastname",
          "outbound" : {
            "source" : {
              "path" : "$user/familyName"
            }
          }
        } ],
        "activation" : {
          "administrativeStatus" : {
            "outbound" : {
              "@id" : 5
            }
          }
        },
        "credentials" : {
          "password" : {
            "outbound" : {
              "@id" : 6
            }
          }
        }
      }
    },
    "capabilities" : {
      "configured" : {
        "activation" : {
          "status" : {
            "attribute" : "ri:disabled",
            "enableValue" : "false",
            "disableValue" : "true"
          }
        }
      }
    }
  }
}
```
Tokens:
Raw