Jump to

• Request
• Response
• Examples

Submit User Self Registration Request

post

/iam/governance/selfservice/api/v1/unauthservice/selfregistration

Submits a user self registration request based on template data.

Request

Supported Media Types

• application/json

Body ()

Attributes of user to be created

Root Schema : SelfRegistrationRequest

Type: object

Show Source

• challengeQuestions(optional): array challengeQuestions
• requestDataMap(optional): object RequestDataMap
• userCredentials(optional): object UserIdandPasswordDetails

{
    "properties":{
        "requestDataMap":{
            "$ref":"#/definitions/RequestDataMap"
        },
        "challengeQuestions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/QueAndAnsMap"
            }
        },
        "userCredentials":{
            "$ref":"#/definitions/UserIdandPasswordDetails"
        }
    }
}

Nested Schema : challengeQuestions

Type: array

Show Source

• Array of: object QueAndAnsMap

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

Nested Schema : RequestDataMap

Type: object

Show Source

• attributeName(optional): string
• id(optional): string

{
    "properties":{
        "id":{
            "type":"string"
        },
        "attributeName":{
            "type":"string"
        }
    }
}

Nested Schema : UserIdandPasswordDetails

Type: object

Show Source

• ConfirmPassword(optional): string(password)
• Password(optional): string(password)
• UserLogin(optional): string

{
    "properties":{
        "UserLogin":{
            "type":"string"
        },
        "Password":{
            "type":"string",
            "format":"password"
        },
        "ConfirmPassword":{
            "type":"string",
            "format":"password"
        }
    }
}

Nested Schema : QueAndAnsMap

Type: object

Show Source

• <ChallengeQuestion>(optional): string

{
    "properties":{
        "<ChallengeQuestion>":{
            "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 : SelfRegistrationResponse

Type: object

Show Source

• links(optional): array links
• request(optional): object Request
• status(optional): string

{
    "properties":{
        "request":{
            "$ref":"#/definitions/Request"
        },
        "status":{
            "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"
    }
}

Nested Schema : Request

Type: object

Show Source

• id(optional): string
• links(optional): array links

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

Nested Schema : LinkDataInstances

Type: object

Show Source

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

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

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

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

404 Response

Resource not found

500 Response

Internal Server Error

Default Response

Unexpected error

Back to Top

Examples

This demonstrates the ability for a user to self register for Oracle Identity Manager. 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/unauthservice/selfregistration

Example of POST Request Body

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

{
  "requestDataMap": [
    {
      "name": "First Name",
      "value": "Ashish123"
    },
    {
      "name": "Last Name",
      "value": "Kumar123"
    },
    {
      "name": "Email",
      "value": "[e-mail]"
    }
  ],
  "challengeQuestions": [
    {
      "name": "What is your mother's maiden name?",
      "value": "value of challenge question 1"
    },
    {
      "name": "What is the name of your pet?",
      "value": "value of challenge question 2"
    },
    {
      "name": "What is the city of your birth?",
      "value": "value of challenge question 3"
    }
  ],
  "userCredentials": [
    {
      "name": "User Login",
      "value": "qwe1@123"
    },
    {
      "name": "usr_password",
      "value": "PASSWORD"
    },
    {
      "name": "Confirm Password",
      "value": "PASSWORD"
    }
  ]
}

Example of POST Response Body

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

{
    "links": [
        {
            "rel": "self",
            "href": "https://pseudo.com/iam/governance/selfservice/api/v1/unauthservice/selfregistration"
        }
    ],
    "request": {
        "name": "id",
        "value": "5002",
        "link": {
            "rel": "self",
            "href": "https://pseudo.com/iam/governance/selfservice/api/v1/requests/5002"
        }
    },
    "status": "Request Created"
}

Back to Top