ReferenceAdmin
Map an IdP group to a team role (platform admins with a session; audited)
POST
/v1/admin/group-mapping/rulesApplied at once to the people whose groups at their last sign-in include the group (see adminPreviewGroupRule), then at every sign-in. Memberships added by hand are never changed. Audited as platform.sso_rule_create; each membership change as team.member_add or team.member_role_change by the system, with the rule in its metadata. 409 rule_exists when the team has a rule for the group; 409 team_archived for an archived team.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/admin/group-mapping/rules" \ -H "Content-Type: application/json" \ -d '{ "group": "registrar-staff", "team": "registrar", "role": "owner" }'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "group": "registrar-staff", "team": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "slug": "string", "name": "string" }, "teamStatus": "active", "role": "owner", "memberCount": 0, "revision": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }}