Map IdP group to Onezone group
Maps external IdP group Id into internal group Id in Onezone. The IdP must have group mapping enabled.
The group does not have to exist in Onezone or the IdP - this method merely transforms the Id using a deterministic procedure. It can be used to predict the group Id in Onezone before it is created.
This operation has public access.
Example cURL requests
Map IdP group to Onezone group
curl -H 'Content-type: application/json' \
-d '{"idp": "elixir", "groupId": "elixir:members"}' \
-X POST https://onezone.example.com/api/v3/onezone/provider/public/map_idp_group
{
"groupId": "302da048de67e2ea05f0af1d0fe7c8a2"
}
Request body
Mapping parameters
External IdP (identity provider).
GroupId in given IdP.
Request Examples
onezone-rest-cli mapIdpGroup ipd==elixir groupId==elixir:membersResponses
The group Id in external IdP.
Internal group Id in Onezone.
Example
{
"groupId": "302da048de67e2ea05f0af1d0fe7c8a2"
}Invalid request.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Authentication error.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Authorization error.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Resource not found.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Internal server Error.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}