Preregister Group

POST/api/v2/admin/enrollments/{enrollmentRid}/authenticationProviders/{authenticationProviderRid}/preregisterGroup

Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Register a Group with a given name before any users with this group log in through this Authentication Provider. Preregistered groups can be used anywhere other groups are used in the platform.

Path parameters

enrollmentRid

string

authenticationProviderRid

string

Query parameters

preview

boolean

optional

Enables the use of preview functionality.

Request body

PreregisterGroupRequest

object

Hide child attributes

name

string

The name of the Group.

organizations

list<OrganizationRid>

optional

The RIDs of the Organizations that can view this group.

Show child attributes

Response body

PrincipalId

string

The ID of a Foundry Group or User.

Examples

Request

Copied!

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/admin/enrollments/ri.control-panel.main.customer.466f812b-f974-4478-9d4f-90402cd3def6/authenticationProviders/ri.control-panel.main.saml.3faf689c-eaa1-4137-851f-81d58afe4c86/preregisterGroup?preview=true" \
	-d '{"name":"Data Source Admins","organizations":["ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"]}'

Response

Copied!

f05f8da4-b84c-4fca-9c77-8af0b13d11de

Error responses

Error Name
`PreregisterGroupPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	Could not preregisterGroup the AuthenticationProvider.
	Parameters	`enrollmentRid, authenticationProviderRid`
`AuthenticationProviderNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The given AuthenticationProvider could not be found.
	Parameters	`enrollmentRid, authenticationProviderRid`

See Errors for a general overview of errors in the platform.