Jump to

• Request
• Response
• Examples

Disable an Account

post

/access-governance/identities/20250331/identities/{identityId}/accounts/{accountId}/action/disable

Disables an Account by identifier.

Request

Path Parameters

• accountId(required): string
  Unique Account id.
• identityId(required): string
  Unique Identity id.

Query Parameters

• orchestratedSystemId: string
  Minimum Length: 1

  Maximum Length: 255

  A filter to return only resources that match given orchestrated system identifier.

Header Parameters

• opc-request-id: string
  The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Disables the Account for the given Account Id.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : AccountData

Type: object

Information about the user account.

Show Source

• attributes(required): array attributes
  Account attributes.

{
    "type":"object",
    "required":[
        "attributes"
    ],
    "properties":{
        "attributes":{
            "type":"array",
            "description":"Account attributes.",
            "items":{
                "$ref":"#/definitions/Attribute"
            }
        }
    },
    "description":"Information about the user account."
}

Nested Schema : attributes

Type: array

Account attributes.

Show Source

• Array of: object Attribute
  Attribute of the account.

{
    "type":"array",
    "description":"Account attributes.",
    "items":{
        "$ref":"#/definitions/Attribute"
    }
}

Nested Schema : Attribute

Type: object

Attribute of the account.

Show Source

• action: string
  Allowed Values: [ "ADD", "UPDATE" ]

  Operation to be done on the attribute.
• additionalAttributes: array additionalAttributes
  Additional attributes.
• attributes: array attributes
  Attributes.
• displayName: string
  Display Name of the attribute.
• name(required): string
  Name of the attribute.
• value: array value
  Value of the attribute.

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the attribute."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of the attribute."
        },
        "value":{
            "type":"array",
            "description":"Value of the attribute.",
            "items":{
                "type":"string"
            }
        },
        "action":{
            "type":"string",
            "description":"Operation to be done on the attribute.",
            "enum":[
                "ADD",
                "UPDATE"
            ],
            "x-obmcs-top-level-enum":"#/definitions/AttributeAction"
        },
        "additionalAttributes":{
            "type":"array",
            "description":"Additional attributes.",
            "items":{
                "$ref":"#/definitions/AdditionalAttribute"
            }
        },
        "attributes":{
            "type":"array",
            "description":"Attributes.",
            "items":{
                "$ref":"#/definitions/Attribute"
            }
        }
    },
    "description":"Attribute of the account."
}

Nested Schema : additionalAttributes

Type: array

Additional attributes.

Show Source

• Array of: object AdditionalAttribute
  Additional Attribute.

{
    "type":"array",
    "description":"Additional attributes.",
    "items":{
        "$ref":"#/definitions/AdditionalAttribute"
    }
}

Nested Schema : attributes

Type: array

Attributes.

Show Source

• Array of: object Attribute
  Attribute of the account.

{
    "type":"array",
    "description":"Attributes.",
    "items":{
        "$ref":"#/definitions/Attribute"
    }
}

Nested Schema : value

Type: array

Value of the attribute.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Value of the attribute.",
    "items":{
        "type":"string"
    }
}

Nested Schema : AdditionalAttribute

Type: object

Additional Attribute.

Show Source

• name(required): string
  Name of the attribute.
• value(required): array value
  Value of the attribute.

{
    "type":"object",
    "required":[
        "name",
        "value"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the attribute."
        },
        "value":{
            "type":"array",
            "description":"Value of the attribute.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Additional Attribute."
}

Nested Schema : value

Type: array

Value of the attribute.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Value of the attribute.",
    "items":{
        "type":"string"
    }
}

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

409 Response

Conflict

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

429 Response

Too Many Requests

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

Default Response

Unknown Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

Back to Top

Examples

The following example shows how you can disabled an account. orchestratedSystemId is the required query parameter.

Note:

You can do this operation only for orchestrated systems that support it. To check, list the accounts for an identity and look for the canDisable status. The operation is supported if you see "canDisable": true.

cURL Example POST

curl -i -X POST \
   -H "Authorization:Bearer <your-access-token>" \
   -H "Content-Type:application/json" \
 '<${service-instance-url}/access-governance/identities/20250331/identities/${identityId}/accounts/${accountId}/action/disable?targetId=${orchestratedSystemId}>'

Submit the POST request

Use the orchestratedSystemId in the query parameter.

${service-instance-url}/access-governance/identities/20250331/identities/${identityId}/accounts/${accountId}/action/disable?targetId=${orchestratedSystemId}>

Example of the Response Code

You'll receive a 200 OK Response code with the following Response body:

{
  "targetIdentityId": "targetId.account.ICF.xxx68424-59xx-45cd-bxxx-10fcaxxx82946.dcf62aba2cabxxx7e5d7421afx7daf7e0bae",
  "globalIdentityId": "globalId.8d51xxbf-ab68-4fxx-ae89-xbccxx9de5be.147xxx.a84xxx862e09xxba29e9002afd63a7fb",
  "orchestratedSystemId": "307xxxx4-598c-4xxx-be94-10xxxxx2946"
} 

Verify Results

You can view a list of accounts for an identity and check the status. During the process, transition status is set as DISABLE_IN_PROGRESS, which when completed shows DISABLED.

Back to Top