REST2 - Revision history

Robl: /* Search Users by Partial Email Address */

2025-03-13T14:55:57Z

Search Users by Partial Email Address

← Older revision		Revision as of 10:55, 13 March 2025
Line 235:		Line 235:
	=== Search Users by Partial Email Address ===		=== Search Users by Partial Email Address ===

	* This example adds the Email address, and a few more useful fields to the results:		* Find all users with email address domain example.com.
			* This example adds the Email address and a few more useful fields to the results:

	curl https://<your_server>/REST/2.0/users'''?fields=id,Name,EmailAddress,RealName,Organization'''\		curl https://<your_server>/REST/2.0/users'''?fields=id,Name,EmailAddress,RealName,Organization'''\
Line 281:		Line 282:
	* Note: Only enabled users are retuned by default. You can add "&find_disabled_rows=1" to the URL show disabled users, but there appears to be no way to include the "Disabled" field, or to search on it e.g. "find only disabled users".		* Note: Only enabled users are retuned by default. You can add "&find_disabled_rows=1" to the URL show disabled users, but there appears to be no way to include the "Disabled" field, or to search on it e.g. "find only disabled users".
	* It also doesn't seem possible to search for Privileged users?		* It also doesn't seem possible to search for Privileged users?


	== Clients for RT REST2 API ==		== Clients for RT REST2 API ==

2025-03-13T14:43:58Z

@@ Line 160: / Line 160: @@
 * You can also add fields= parameter to the url to include otherwise hidden fields:
-  curl  https://<your_server>/REST/2.0/groups?fields=Name,Description,Domain,CustomFields --request POST \
+  curl https://<your_server>/REST/2.0/groups?fields=Name,Description,Domain,CustomFields --request POST \
      --header "Authorization: token <your_token>" \
      --no-buffer \
@@ Line 169: / Line 169: @@
+              }
          ]'
 == Clients for RT REST2 API ==

2025-03-13T13:23:10Z

RT System Information

← Older revision		Revision as of 09:23, 13 March 2025
Line 76:		Line 76:
	}		}

			* Plugins list will only be present if the user has SuperUser privileges in RT.

	=== Create New User ===		=== Create New User ===

2025-03-13T13:19:45Z

Examples

← Older revision		Revision as of 09:19, 13 March 2025
Line 49:		Line 49:

	== Examples ==		== Examples ==

			=== RT System Information ===

			* A good start to check it's working and authenticating correctly:

			curl -s -X GET \
			-H "Authorization: token <your_token>" \
			-H "Accept: application/json" \
			"https://<your_server>/REST/2.0/rt"

			Returns similar to:

			{
			"Version" : "5.0.7",
			"Plugins" : [
			"RT::Extension::BooleanCustomField",
			"RT::Extension::CustomFieldsOnUpdate",
			"RT::Extension::NonWatcherRecipients",
			"RT::Extension::Tags",
			"RT::Authen::OAuth2",
			"RT::Extension::CommandByMail",
			"RT::Extension::RepliesToResolved",
			"RT::Extension::TicketLocking",
			"RTx::Calendar"
			]
			}


	=== Create New User ===		=== Create New User ===

2025-03-13T12:54:13Z

Search for group by name

← Older revision		Revision as of 08:54, 13 March 2025
Line 70:		Line 70:
	=== Search for group by name ===		=== Search for group by name ===

	- This example searches for a group "Staff" and returns the details:		* This example searches for a group "Staff" and returns the details:

	curl --silent "https://<your_server>/REST/2.0/groups" \		curl --silent "https://<your_server>/REST/2.0/groups" \

2025-03-13T12:52:14Z

Get only user defined groups

← Older revision		Revision as of 08:52, 13 March 2025
Line 118:		Line 118:
	=== Get only user defined groups ===		=== Get only user defined groups ===

	* The groups query returns all groups by default, including internal groups (e.g. role groups for tickets.) This can return many thousands groups, which is unhelpful. The output also doesn't contain the group's name or type. To return only User Defined groups (e.g actual groups users are added to in RT.)		* The groups query returns all groups by default, including internal groups (e.g. role groups for tickets.) This can return many thousands groups, which is unhelpful. The output also doesn't contain the group's name or type. To return only User Defined groups (e.g actual groups users are added to in RT.):

	curl https://<your_server>/REST/2.0/groups --request POST \		curl https://<your_server>/REST/2.0/groups --request POST \

2025-03-13T12:51:32Z

Get only user defined groups

← Older revision		Revision as of 08:51, 13 March 2025
Line 130:		Line 130:
	]'		]'

	You can also add fields= parameter to the url to include otherwise hidden fields:		* You can also add fields= parameter to the url to include otherwise hidden fields:

	curl https://<your_server>/REST/2.0/groups?fields=Name,Description,Domain,CustomFields --request POST \		curl https://<your_server>/REST/2.0/groups?fields=Name,Description,Domain,CustomFields --request POST \
Line 141:		Line 141:
	}		}
	]'		]'




	== Clients for RT REST2 API ==		== Clients for RT REST2 API ==

2025-03-13T12:51:09Z

Add User to Group

← Older revision		Revision as of 08:51, 13 March 2025
Line 112:		Line 112:

	$ curl ... <as above> \| jq -r '.items[].id'		$ curl ... <as above> \| jq -r '.items[].id'
	~~17474~~		71414

	* If you are doing anything serious, it is better to use a scripting language such as python or perl, which has support for JSON and nested data structures. But by way of example, I have posted a simple example of a bash script to add a user to a group using the REST2 API: [https://gist.github.com/listerr/d847fe56e7d40fa06840d744762d1bc6 rt-groupadd]		* If you are doing anything serious, it is better to use a scripting language such as python or perl, which has support for JSON and nested data structures. But by way of example, I have posted a simple example of a bash script to add a user to a group using the REST2 API: [https://gist.github.com/listerr/d847fe56e7d40fa06840d744762d1bc6 rt-groupadd]

2025-03-13T12:50:47Z

Search for group by name

← Older revision		Revision as of 08:50, 13 March 2025
Line 72:		Line 72:
	- This example searches for a group "Staff" and returns the details:		- This example searches for a group "Staff" and returns the details:

	curl --silent "<your_server>/REST/2.0/groups" \		curl --silent "https://<your_server>/REST/2.0/groups" \
	--request POST \		--request POST \
	--header "Authorization: token <your_token>" \		--header "Authorization: token <your_token>" \

2025-03-13T12:50:32Z

Create New User

← Older revision		Revision as of 08:50, 13 March 2025
Line 52:		Line 52:
	=== Create New User ===		=== Create New User ===

	curl "~~$RT_URL~~/REST/2.0/user" \		curl "https://<your_server>/REST/2.0/user" \
	--request POST \		--request POST \
	--header "Authorization: token $RT_TOKEN" \		--header "Authorization: token $RT_TOKEN" \