Jump to

• Request
• Response
• Examples

Create Users

post

/iam/governance/selfservice/api/v1/users

Creates the users in Oracle Identity Manager. The user attributes are mentioned as part of the payload. The logged in user should have the necessary privileges to create a user in Oracle Identity Manager.

Request

Supported Media Types

• application/json

Body ()

Attributes of the user which is to be created.

Root Schema : PostUsersRequest

Type: object

Show Source

• users(optional): array users

{
    "properties":{
        "users":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PostUserRequest"
            }
        }
    }
}

Nested Schema : users

Type: array

Show Source

• Array of: object PostUserRequest

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PostUserRequest"
    }
}

Nested Schema : PostUserRequest

Type: object

Show Source

• fields(optional): array fields
• requestId(optional): string

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "fields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Fields"
            }
        }
    }
}

Nested Schema : fields

Type: array

Show Source

• Array of: object Fields

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Fields"
    }
}

Nested Schema : Fields

Type: object

Show Source

• name(optional): string
• value(optional): string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful

Headers

• ResponseTime: string
  Captures the time in milliseconds taken for processing the request.

Body ()

Root Schema : PostUsersResponse

Type: object

Show Source

• links(optional): array links
• users(optional): array users

{
    "properties":{
        "users":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PostUserResponse"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

Nested Schema : users

Type: array

Show Source

• Array of: object PostUserResponse

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PostUserResponse"
    }
}

Nested Schema : LinkDataInstances

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : PostUserResponse

Type: object

Show Source

• id(optional): string
• links(optional): array links
• name(optional): string
• requestId(optional): string
• status(optional): string

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Resource not found

500 Response

Internal Server Error

Back to Top

Examples

This example demonstrates the ability for bulk operation of creating users. The information shown here is against a pseudo system and serves as a prototype.

cURL Example

curl  -H "Content-Type: application/json"  -H "X-Requested-By: <anyvalue>"  -X POST  -u username:password  -d @post.json https://pseudo.com/iam/governance/selfservice/api/v1/users

Example of POST Request Body

The following example shows the contents of the request body in JSON format.

{
  "users": [
    {
      "requestId": "123",
      "fields": [
        {
          "name": "Last Name",
          "value": "UNIQUE_NAME LN1"
        },
        {
          "name": "Role",
          "value": "EMP"
        },
        {
          "name": "act_key",
          "value": 1
        }
      ]
    },
    {
      "requestId": "1234",
      "fields": [
        {
          "name": "Last Name",
          "value": "UNIQUE_NAME LN2"
        },
        {
          "name": "Role",
          "value": "EMP"
        },
        {
          "name": "act_key",
          "value": 2
        }
      ]
    }
  ]
}

Example of POST Response Body

The following example shows the contents of the response body in JSON format.

{
  "links": [
    {
      "rel": "self",
      "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users"
    }
  ],
  "users": [
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/12095"
        }
      ],
      "id": "12095",
      "status": " SUCCESS",
      "requestId": "123",
      "name": "UNIQUE_NAME LN1"
    },
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/12096"
        }
      ],
      "id": "12096",
      "status": " SUCCESS",
      "requestId": "1234",
      "name": "UNIQUE_NAME LN2"
    }
  ]
}

Back to Top