Replace Group Provider Info

PUT/api/v2/admin/groups/{groupId}/providerInfo

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.

Replace the GroupProviderInfo.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:admin-write.

Path parameters

groupId

string

The ID of a Foundry Group or User.

Query parameters

preview

boolean

optional

Enables the use of preview functionality.

Request body

ReplaceGroupProviderInfoRequest

object

Hide child attributes

providerId

string

The ID of the Group in the external authentication provider. This value is determined by the authentication provider. At most one Group can have a given provider ID in a given Realm.

Response body

GroupProviderInfo

object

The replaced GroupProviderInfo

Hide child attributes

providerId

string

The ID of the Group in the external authentication provider. This value is determined by the authentication provider. At most one Group can have a given provider ID in a given Realm.

Examples

Request

Copied!

curl -X PUT \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/admin/groups/f05f8da4-b84c-4fca-9c77-8af0b13d11de/providerInfo?preview=true" \
	-d '{"providerId":"2838c8f3-d76a-4e99-acf1-1dee537e4c48"}'

Response

Copied!

{
  "providerId": "2838c8f3-d76a-4e99-acf1-1dee537e4c48"
}

Error responses

Error Name
`ReplaceGroupProviderInfoPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	Could not replace the GroupProviderInfo.
	Parameters	`groupId`

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