SAML Group Mappings
Get SAML Group Mappings
Returns a list of all SAML group mappings
GET /api/v2/sso/saml/group-mappings/
GET /api/v2/sso/saml/group-mappings/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"sde_group": "G1",
"id": 1,
"last_modified": "2023-02-28T18:29:06.318772Z",
"saml_group": "Developers"
},
{
"sde_group": "G2",
"id": 2,
"last_modified": "2023-02-28T16:56:10.133151Z",
"saml_group": "Administrators"
}
]
}
Expand Filters
See the Expand Parameters section for more details.
| Parameter | Description |
|---|---|
| sde_group | sde_group fields are expanded to include the sde_group name |
GET /api/v2/sso/saml/group-mappings/?expand=sde_group HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"
HTTP/1.1 200 OK
Content-Type: application/json
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"sde_group": {
"id": "G1",
"name": "group_1"
},
"id": 1,
"last_modified": "2023-02-28T18:29:06.318772Z",
"saml_group": "Developers"
},
{
"sde_group": {
"id": "G2",
"name": "group_2"
},
"id": 2,
"last_modified": "2023-02-28T16:56:10.133151Z",
"saml_group": "Administrators"
}
]
}
Query Parameters
Use the following parameters to filter the query resources in the response.
| Parameter | Description |
|---|---|
| search | Filter search queries by one or more of saml_group and sde_group__name. |
Delete a SAML Group Mapping
This endpoint deletes a single SAML group mapping resource, as specified by the id parameter.
DELETE /api/v2/sso/saml/group-mappings/{saml-group-mapping-id}/
DELETE /api/v2/sso/saml/group-mappings/1/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"
HTTP/1.1 204 NO Content
Create a SAML Group Mapping
Creates a SAML group mapping resource.
POST /api/v2/sso/saml/group-mappings/
| Fields | Required | Description |
|---|---|---|
| saml_group | Yes | The value of the idp group. |
| sde_group | Yes | The ID of the SDE group that the SAML group maps to. |
POST /api/v2/sso/saml/group-mappings/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"
{
"saml_group": ["Developers", "Architects"],
"sde_group": "G1"
}
HTTP/1.1 201 CREATED
Content-Type: application/json
{
"sde_group": "G1",
"id": 1,
"last_modified": "2023-02-28T16:27:46.216296-05:00",
"saml_group": ["Developers", "Architects"]
}
Update a specific SAML Group Mapping
Updates a specific SAML group mapping resource.
PUT /api/v2/sso/saml/group-mappings/{saml-group-mapping-id}/
| Fields | Required | Description |
|---|---|---|
| saml_group | Yes | The name of the SAML group. |
| sde_group | Yes | The ID of the SDE group that the SAML group maps to. |
PUT /api/v2/sso/saml/group-mappings/1/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"
{
"saml_group": "Developers",
"sde_group": "G1"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"sde_group": "G1",
"id": 1,
"last_modified": "2023-02-28T16:27:46.216296-05:00",
"saml_group": "Developers"
}