Jump to

• Request
• Response

Updates an Organization

put

/access-governance/service-administration/20250331/organizations/{organizationId}

Updates the Organization identified by the given identifier.

Request

Path Parameters

• organizationId(required): string
  The unique id for an Organization. Available values can be found using the ListOrganizations operation.

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.

Body ()

Information used to update an Organization.

Root Schema : UpdateOrganizationDetails

Type: object

Information used to update an Organization.

Show Source

• description: string
  Maximum Length: 255

  Description of the Organization.
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  Display name of the Organization.
• excludedIdentities: array excludedIdentities
  Global Identity identifiers to explicitly exclude from the Organization.
• externalId: string
  External identifier to associate with the Organization.
• includedIdentities: array includedIdentities
  Global Identity identifiers to explicitly include in the Organization.
• membershipRule: string
  Maximum Length: 2550

  Membership rule for the Organization.
• name(required): string
  Minimum Length: 1

  Maximum Length: 255

  Name of the Organization.
• owners: array owners
  Users who own the Organization.
• status: string
  Allowed Values: [ "ACTIVE", "DRAFT", "INACTIVE" ]

  Requested status of the Organization. If omitted, the current status is preserved.
• tags: array tags
  List of tags to attach to the Organization.

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the Organization.",
            "minLength":1,
            "maxLength":255
        },
        "displayName":{
            "type":"string",
            "description":"Display name of the Organization.",
            "minLength":1,
            "maxLength":255
        },
        "description":{
            "type":"string",
            "description":"Description of the Organization.",
            "maxLength":255
        },
        "status":{
            "type":"string",
            "description":"Requested status of the Organization. If omitted, the current status is preserved.",
            "enum":[
                "ACTIVE",
                "DRAFT",
                "INACTIVE"
            ],
            "x-obmcs-top-level-enum":"#/definitions/OrganizationRequestedStatus",
            "x-default-description":"null"
        },
        "membershipRule":{
            "type":"string",
            "description":"Membership rule for the Organization.",
            "maxLength":2550
        },
        "includedIdentities":{
            "type":"array",
            "description":"Global Identity identifiers to explicitly include in the Organization.",
            "items":{
                "type":"string",
                "minLength":1
            }
        },
        "excludedIdentities":{
            "type":"array",
            "description":"Global Identity identifiers to explicitly exclude from the Organization.",
            "items":{
                "type":"string",
                "minLength":1
            }
        },
        "owners":{
            "type":"array",
            "description":"Users who own the Organization.",
            "items":{
                "$ref":"#/definitions/OrganizationOwnerDetails"
            }
        },
        "tags":{
            "type":"array",
            "description":"List of tags to attach to the Organization.",
            "items":{
                "type":"string"
            }
        },
        "externalId":{
            "type":"string",
            "description":"External identifier to associate with the Organization."
        }
    },
    "description":"Information used to update an Organization."
}

Nested Schema : excludedIdentities

Type: array

Global Identity identifiers to explicitly exclude from the Organization.

Show Source

• Array of: string
  Minimum Length: 1

{
    "type":"array",
    "description":"Global Identity identifiers to explicitly exclude from the Organization.",
    "items":{
        "type":"string",
        "minLength":1
    }
}

Nested Schema : includedIdentities

Type: array

Global Identity identifiers to explicitly include in the Organization.

Show Source

• Array of: string
  Minimum Length: 1

{
    "type":"array",
    "description":"Global Identity identifiers to explicitly include in the Organization.",
    "items":{
        "type":"string",
        "minLength":1
    }
}

Nested Schema : owners

Type: array

Users who own the Organization.

Show Source

• Array of: object OrganizationOwnerDetails
  Owner information supplied when creating or updating an Organization.

{
    "type":"array",
    "description":"Users who own the Organization.",
    "items":{
        "$ref":"#/definitions/OrganizationOwnerDetails"
    }
}

Nested Schema : tags

Type: array

List of tags to attach to the Organization.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of tags to attach to the Organization.",
    "items":{
        "type":"string"
    }
}

Nested Schema : OrganizationOwnerDetails

Type: object

Owner information supplied when creating or updating an Organization.

Show Source

• id(required): string
  Minimum Length: 1

  Unique identifier of the owner.
• isPrimary(required): boolean
  Indicates whether this user is the primary owner.
• name(required): string
  Minimum Length: 1

  Maximum Length: 255

  Name of the owner.

{
    "type":"object",
    "required":[
        "id",
        "isPrimary",
        "name"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the owner.",
            "minLength":1
        },
        "name":{
            "type":"string",
            "description":"Name of the owner.",
            "minLength":1,
            "maxLength":255
        },
        "isPrimary":{
            "type":"boolean",
            "description":"Indicates whether this user is the primary owner."
        }
    },
    "description":"Owner information supplied when creating or updating an Organization."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The Organization was successfully updated.

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 : Organization

An Access Governance Organization.

Match All

An Access Governance Organization.

An Access Governance Organization.

Show Source

• object OrganizationSummary
  Summarized Organization model.
• object Organization-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/OrganizationSummary"
        },
        {
            "type":"object",
            "properties":{
                "updatedBy":{
                    "$ref":"#/definitions/Info"
                },
                "includedIdentities":{
                    "type":"array",
                    "description":"Identities explicitly included in the Organization.",
                    "items":{
                        "$ref":"#/definitions/OrganizationIdentityReference"
                    }
                },
                "excludedIdentities":{
                    "type":"array",
                    "description":"Identities explicitly excluded from the Organization.",
                    "items":{
                        "$ref":"#/definitions/OrganizationIdentityReference"
                    }
                },
                "owners":{
                    "type":"array",
                    "description":"Users who own the Organization.",
                    "items":{
                        "$ref":"#/definitions/User"
                    }
                },
                "externalId":{
                    "type":"string",
                    "description":"External identifier associated with the Organization."
                }
            }
        }
    ],
    "description":"An Access Governance Organization."
}

Nested Schema : OrganizationSummary

Type: object

Summarized Organization model.

Show Source

• createdBy: object Info
  Generic information object.
• description: string
  Description of the Organization.
• displayName: string
  Display Name of the Organization.
• id(required): string
  Unique identifier that is immutable on creation.
• isOwner: boolean
  Boolean value checking if logged-in user is owner of this organization or not.
• membershipRule: string
  Membership Rule for the Organization.
• name: string
  Name of the Organization.
• organizationType: string
  Type of the Organization.
• primaryOwner: object User
  Owner of a resource.
• status: string
  Allowed Values: [ "ACTIVE", "DRAFT", "INACTIVE", "PENDING", "FAILED", "IN_PROGRESS", "SAVED", "SUCCESS", "TIMEOUT", "PENDING_APPROVAL", "CANCELLED", "APPLYING" ]

  Status of the Organization.
• tags: array tags
  List of tags attached to the Organization.
• timeCreated: string(date-time)
  Time when the Organization was created. An RFC3339 formatted datetime string.
• timeUpdated: string(date-time)
  Time when the Organization was last updated. An RFC3339 formatted datetime string.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier that is immutable on creation."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of the Organization."
        },
        "name":{
            "type":"string",
            "description":"Name of the Organization."
        },
        "description":{
            "type":"string",
            "description":"Description of the Organization."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the Organization was created. An RFC3339 formatted datetime string."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the Organization was last updated. An RFC3339 formatted datetime string."
        },
        "organizationType":{
            "type":"string",
            "description":"Type of the Organization."
        },
        "createdBy":{
            "$ref":"#/definitions/Info"
        },
        "membershipRule":{
            "type":"string",
            "description":"Membership Rule for the Organization."
        },
        "status":{
            "type":"string",
            "description":"Status of the Organization.",
            "enum":[
                "ACTIVE",
                "DRAFT",
                "INACTIVE",
                "PENDING",
                "FAILED",
                "IN_PROGRESS",
                "SAVED",
                "SUCCESS",
                "TIMEOUT",
                "PENDING_APPROVAL",
                "CANCELLED",
                "APPLYING"
            ],
            "x-obmcs-top-level-enum":"#/definitions/OrganizationStatus",
            "x-default-description":"ACTIVE"
        },
        "tags":{
            "type":"array",
            "description":"List of tags attached to the Organization.",
            "items":{
                "type":"string"
            }
        },
        "primaryOwner":{
            "$ref":"#/definitions/User"
        },
        "isOwner":{
            "type":"boolean",
            "description":"Boolean value checking if logged-in user is owner of this organization or not."
        }
    },
    "description":"Summarized Organization model."
}

Nested Schema : Organization-allOf[1]

Type: object

Show Source

• excludedIdentities: array excludedIdentities
  Identities explicitly excluded from the Organization.
• externalId: string
  External identifier associated with the Organization.
• includedIdentities: array includedIdentities
  Identities explicitly included in the Organization.
• owners: array owners
  Users who own the Organization.
• updatedBy: object Info
  Generic information object.

{
    "type":"object",
    "properties":{
        "updatedBy":{
            "$ref":"#/definitions/Info"
        },
        "includedIdentities":{
            "type":"array",
            "description":"Identities explicitly included in the Organization.",
            "items":{
                "$ref":"#/definitions/OrganizationIdentityReference"
            }
        },
        "excludedIdentities":{
            "type":"array",
            "description":"Identities explicitly excluded from the Organization.",
            "items":{
                "$ref":"#/definitions/OrganizationIdentityReference"
            }
        },
        "owners":{
            "type":"array",
            "description":"Users who own the Organization.",
            "items":{
                "$ref":"#/definitions/User"
            }
        },
        "externalId":{
            "type":"string",
            "description":"External identifier associated with the Organization."
        }
    }
}

Nested Schema : Info

Type: object

Generic information object.

Show Source

• displayName: string
  Display Name of the entity.
• id: string
  id of the entity.
• name: string
  name of the entity.
• owners: array owners
  List of owner entities

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the entity."
        },
        "name":{
            "type":"string",
            "description":"name of the entity."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of the entity."
        },
        "owners":{
            "type":"array",
            "description":"List of owner entities",
            "items":{
                "$ref":"#/definitions/OwnerSummary"
            }
        }
    },
    "description":"Generic information object."
}

Nested Schema : User

Type: object

Owner of a resource.

Show Source

• displayName: string
  Display name of the owner.
• id: string
  Global id of the owner.
• isPrimary: boolean
  Is user a primary owner.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Global id of the owner."
        },
        "displayName":{
            "type":"string",
            "description":"Display name of the owner."
        },
        "isPrimary":{
            "type":"boolean",
            "description":"Is user a primary owner."
        }
    },
    "description":"Owner of a resource."
}

Nested Schema : tags

Type: array

List of tags attached to the Organization.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of tags attached to the Organization.",
    "items":{
        "type":"string"
    }
}

Nested Schema : owners

Type: array

List of owner entities

Show Source

• Array of: object OwnerSummary
  Owner entity object

{
    "type":"array",
    "description":"List of owner entities",
    "items":{
        "$ref":"#/definitions/OwnerSummary"
    }
}

Nested Schema : OwnerSummary

Type: object

Owner entity object

Show Source

• id(required): string
  Unique identifier that is immutable on creation
• isPrimary(required): boolean
  Is this entity the primary owner?
• name(required): string
  Name of the owner

{
    "type":"object",
    "required":[
        "id",
        "isPrimary",
        "name"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier that is immutable on creation"
        },
        "name":{
            "type":"string",
            "description":"Name of the owner"
        },
        "isPrimary":{
            "type":"boolean",
            "description":"Is this entity the primary owner?"
        }
    },
    "description":"Owner entity object"
}

Nested Schema : excludedIdentities

Type: array

Identities explicitly excluded from the Organization.

Show Source

• Array of: object OrganizationIdentityReference
  Reference to an Identity used to define Organization membership.

{
    "type":"array",
    "description":"Identities explicitly excluded from the Organization.",
    "items":{
        "$ref":"#/definitions/OrganizationIdentityReference"
    }
}

Nested Schema : includedIdentities

Type: array

Identities explicitly included in the Organization.

Show Source

• Array of: object OrganizationIdentityReference
  Reference to an Identity used to define Organization membership.

{
    "type":"array",
    "description":"Identities explicitly included in the Organization.",
    "items":{
        "$ref":"#/definitions/OrganizationIdentityReference"
    }
}

Nested Schema : owners

Type: array

Users who own the Organization.

Show Source

• Array of: object User
  Owner of a resource.

{
    "type":"array",
    "description":"Users who own the Organization.",
    "items":{
        "$ref":"#/definitions/User"
    }
}

Nested Schema : OrganizationIdentityReference

Type: object

Reference to an Identity used to define Organization membership.

Show Source

• id(required): string
  Minimum Length: 1

  Unique identifier of the Identity.
• name: string
  Maximum Length: 255

  Optional display name of the Identity.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the Identity.",
            "minLength":1
        },
        "name":{
            "type":"string",
            "description":"Optional display name of the Identity.",
            "maxLength":255
        }
    },
    "description":"Reference to an Identity used to define Organization membership."
}

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."
}

412 Response

Precondition failed

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