Users Endpoint

Create User

Changed on Jul 17, 2026

This API creates a user and returns the user details along with the user's unique ID.

<b>Scope(Permission) required:</b> internal_user_mgt_create
<b>Flow type:</b> Client Credentials OAuth Flow

post/Users

Request

Base URL
https://api.asgardeo.io/t//scim2
Auth
OAuth 2
Client credentials
TypeScript
https://skmtc.dev/ballerina-platform/apis/scim-2-0-api/docs/Users/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

attributesstring

SCIM defined attributes parameter.

excludedAttributesstring

SCIM defined excludedAttribute parameter.

Request body

Example request

{
  "schemas": [],
  "name": {
    "givenName": "Kim",
    "familyName": "Berry"
  },
  "userName": "DEFAULT/kim@gmail.com",
  "password": "aBcd!23#",
  "emails": [
    {
      "value": "kim@gmail.com",
      "primary": true
    }
  ],
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "manager": {
      "value": "Taylor"
    }
  },
  "urn:scim:wso2:schema": {
    "verifyEmail": true
  }
}

Response

User is created.

schemasstring[]

usernamestring

idstring

Example response

{
  "meta": {
    "created": "2018-08-17T10:34:29.000Z",
    "location": "https://api.asgardeo.io/t/{org-name}/scim2/Users/008bba85-451d-414b-87de-c03b5a1f4217",
    "lastModified": "2018-08-17T10:34:29.000Z",
    "resourceType": "User"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
  ],
  "username": "DEFAULT/kim@gmail.com",
  "id": "008bba85-451d-414b-87de-c03b5a1f4217",
  "name": {
    "givenName": "Kim",
    "familyName": "Berry"
  },
  "emails": [
    "kim@gmail.com"
  ],
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "manager": {
      "value": "Taylor"
    }
  },
  "roles": [
    {
      "type": "default",
      "value": "Internal/everyone"
    }
  ]
}

Changes

Jul 17, 20267978594f207e Revision changes
- breaking
  the / request property type changed from object to array
- breaking
  the / request property type changed from object to array
- breaking
  response property emails/items/ list-of-types was widened by adding types string to media type application/scim+json of response 201
- breaking
  the response's property type changed from object to array for status
- breaking
  the response's property type changed from object to array for status
Aug 14, 2025d290ee2c70fc Revision changes
- breaking
  the / request property type changed from array to object
- breaking
  the / request property type changed from array to object
- breaking
  the response's property type changed from array to object for status
- breaking
  the response's property type changed from array to object for status
- info
  response property emails/items/ list-of-types was narrowed by removing types string from media type application/scim+json of response 201

Operation history