---
title: "IAM API"
url: "https://developer.migros.ch/apis/iam-api-0/versions/976fd3d6-52b0-46fb-8b82-33f4b00b51db"
---

# IAM API

OpenAPI specification document.

```json
{"components":{"securitySchemes":{"apiKeyAuth":{"in":"header","name":"Authorization","type":"apiKey"}}},"externalDocs":{"description":"Details about configuration, attribute schema, endpoints, authentication, authorization, and examples....","url":"https://wiki.migros.net/display/IDM/IAM+API"},"info":{"contact":{"email":"tomas.belicek@mgb.ch","name":"MGB-IAM Center of Competence"},"description":"SCIM REST implementation for IAM based on Saviynt","title":"IAM API","version":"0.1.0"},"openapi":"3.0.1","paths":{"/migros/iam/v2/Groups":{"get":{"description":"An endpoint for fetching group data","operationId":"getGroups","responses":{"200":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Message"}},"summary":"GET groups","tags":["iam-api-tag"],"x-kong-plugin-rate-limiting":{"config":{"hour":50000,"second":15}}}},"/migros/iam/v2/Groups/{groupId}":{"get":{"description":"An endpoint for fetching a group data","operationId":"getGroupById","parameters":[{"description":"Group (Entitlement) ID","in":"path","name":"groupId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Message"}},"summary":"GET group","tags":["iam-api-tag"],"x-kong-plugin-rate-limiting":{"config":{"hour":50000,"second":15}}},"patch":{"description":"An endpoint for updating group data","operationId":"patchGroup","parameters":[{"description":"Group (Entitlement) ID","in":"path","name":"groupId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/scim+json":{"schema":{"properties":{"email":{"type":"string"}},"type":"object"}}},"description":"Data to update an existing group","required":true},"responses":{"200":{"description":"Updated"},"500":{"description":"Internal Error"}},"summary":"PATCH group","tags":["iam-api-tag"],"x-kong-plugin-rate-limiting":{"config":{"hour":50000,"second":15}}}},"/migros/iam/v2/Organizations":{"get":{"description":"An endpoint for fetching organization data","operationId":"getOrganizations","responses":{"200":{"content":{"application/scim+json":{"schema":{"type":"string"}}},"description":"Message"}},"summary":"GET organizations","tags":["iam-api-tag"],"x-kong-plugin-rate-limiting":{"config":{"hour":50000,"second":15}}},"post":{"description":"An endpoint for creating organization","operationId":"postOrganizations","requestBody":{"content":{"application/scim+json":{"schema":{"properties":{"email":{"type":"string"},"username":{"type":"string"}},"type":"object"}}},"description":"Data to create a new organization","required":true},"responses":{"201":{"description":"Created"},"500":{"description":"Internal Error"}},"summary":"POST organizations","tags":["iam-api-tag"],"x-kong-plugin-rate-limiting":{"config":{"hour":50000,"second":15}}}},"/migros/iam/v2/Organizations/{orgId}":{"get":{"description":"An endpoint for fetching an organization data","operationId":"getOrganizationById","parameters":[{"description":"Organization id","in":"path","name":"orgId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Message"}},"summary":"GET organization","tags":["iam-api-tag"],"x-kong-plugin-rate-limiting":{"config":{"hour":50000,"second":15}}},"patch":{"description":"An endpoint for updating organization data","operationId":"patchOrganization","parameters":[{"description":"Organization id","in":"path","name":"orgId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/scim+json":{"schema":{"properties":{"email":{"type":"string"}},"type":"object"}}},"description":"Data to update an existing organization","required":true},"responses":{"200":{"description":"Updated"},"500":{"description":"Internal Error"}},"summary":"PATCH organization","tags":["iam-api-tag"],"x-kong-plugin-rate-limiting":{"config":{"hour":50000,"second":15}}}},"/migros/iam/v2/ResourceTypes":{"get":{"description":"An endpoint for resource types","operationId":"getResourceTypes","responses":{"200":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Message"}},"summary":"GET group","tags":["iam-api-tag"],"x-kong-plugin-rate-limiting":{"config":{"hour":50000,"second":15}}}},"/migros/iam/v2/Roles":{"get":{"description":"An endpoint for fetching role data","operationId":"getRoles","responses":{"200":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Message"}},"summary":"GET roles","tags":["iam-api-tag"],"x-kong-plugin-rate-limiting":{"config":{"hour":50000,"second":15}}}},"/migros/iam/v2/Roles/{roleId}":{"get":{"description":"An endpoint for fetching a role data","operationId":"getRoleById","parameters":[{"description":"Role ID","in":"path","name":"roleId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Message"}},"summary":"GET role","tags":["iam-api-tag"],"x-kong-plugin-rate-limiting":{"config":{"hour":50000,"second":15}}}},"/migros/iam/v2/Schemas":{"get":{"description":"An endpoint for fetching API schmea","operationId":"getSchema","responses":{"200":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Message"}},"summary":"GET group","tags":["iam-api-tag"],"x-kong-plugin-rate-limiting":{"config":{"hour":50000,"second":15}}}},"/migros/iam/v2/ServiceProviderConfig":{"get":{"description":"An endpoint for fetching service provider config","operationId":"getServiceProviderConfig","responses":{"200":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Message"}},"summary":"GET group","tags":["iam-api-tag"],"x-kong-plugin-rate-limiting":{"config":{"hour":50000,"second":15}}}},"/migros/iam/v2/Users":{"get":{"description":"An endpoint for fetching user data","operationId":"getUsers","responses":{"200":{"content":{"application/scim+json":{"schema":{"type":"string"}}},"description":"Message"}},"summary":"GET users","tags":["iam-api-tag"],"x-kong-plugin-rate-limiting":{"config":{"hour":50000,"second":15}}},"post":{"description":"An endpoint for creating user data","operationId":"postUsers","requestBody":{"content":{"application/scim+json":{"schema":{"properties":{"email":{"type":"string"},"username":{"type":"string"}},"type":"object"}}},"description":"Data to create a new user","required":true},"responses":{"201":{"description":"Created"},"500":{"description":"Internal Error"}},"summary":"POST users","tags":["iam-api-tag"],"x-kong-plugin-rate-limiting":{"config":{"hour":50000,"second":15}}}},"/migros/iam/v2/Users/{userId}":{"get":{"description":"An endpoint for fetching user data","operationId":"getUserById","parameters":[{"description":"M-Number of a Migros user","in":"path","name":"userId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/scim+json":{"schema":{"type":"string"}}},"description":"Message"}},"summary":"GET user id","tags":["iam-api-tag"],"x-kong-plugin-rate-limiting":{"config":{"hour":50000,"second":15}}},"patch":{"description":"An endpoint for updating user data","operationId":"patchUsers","parameters":[{"description":"M-Number of a Migros user","in":"path","name":"userId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/scim+json":{"schema":{"properties":{"email":{"type":"string"}},"type":"object"}}},"description":"Data to update an existing user","required":true},"responses":{"200":{"description":"Updated"},"500":{"description":"Internal Error"}},"summary":"PATCH users","tags":["iam-api-tag"],"x-kong-plugin-rate-limiting":{"config":{"hour":50000,"second":15}}}}},"servers":[{"description":"URL of upstream IAM API in Azure Kubernetes","url":"https://iamapi.service.migros.cloud"}],"tags":[{"name":"iam-api-tag"}],"x-active-from":"01-01-2025","x-company":"migros","x-edm-domain":"security-and-risks","x-edm-subdomain":"02c4232f-db5e-486d-ab52-8dd0324c765d","x-eol":"31-12-2049","x-headmatter":{"readable_by":"*"},"x-kong-service-defaults":{"connect_timeout":240000,"read_timeout":360000,"retries":2,"write_timeout":240000},"x-leanix-id":"1f0bed47-6818-49c5-a2d5-a6fd3fd6e2b5"}
```