REST API for Oracle Identity Governance Self Service

Update User Status

put

/iam/governance/selfservice/api/v1/users/{uuid}/status

Updates the status (lock/unlock/enable/disable) of the user specified by user ID. The logged in user should have the necessary privileges to update a user's status in Oracle Identity Manager.

Request

Supported Media Types

application/json

Path Parameters

uuid(required): string

User's unique identifier

User's status (enable/disable/lock/unlock) to be updated.

Root Schema : PutStatusRequest

Type: object

Show Source

status: string

{
    "properties":{
        "status":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Successful

Headers

ResponseTime: string

Captures the time in milliseconds taken for processing the request.

Root Schema : PutStatusResponse

Type: object

Show Source

links: array links
status: string

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

Nested Schema : links

Type: array

Show Source

Array of: object LinkDataInstances

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

Nested Schema : LinkDataInstances

Type: object

Show Source

href: string
rel: string

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

401 Response

Unauthorized

404 Response

Requested entity not found

500 Response

Internal Server Error

Examples

cURL Example

This example demonstrates the ability to update a user's status to unlock. The information shown here is against a pseudo system and serves as a prototype.

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

Example of PUT Request Body

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

{
     	"status": "unlock"
     }

Example of the 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/users/82/status"
        }
    ],
    "status": "SUCCESS"
}