Jump to

• Request
• Response

Get My Organizations

get

/api/user/organizations

Returns a list of organizations for which you are designated as the organization administrator.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : Organization

Type: object

Show Source

• addressLine1: string
  Example: 500 Oracle Parkway
• addressLine2: string
• billThroughOracle: boolean
  Example: true
• cityName: string
  Example: Redwood Shores
• claimed: boolean
  Example: true
• code: string
  Example: MYORG
• countryCode: string
  Example: USA
• county: string
  Example: Chester
• deliveryAddressLine1: string
  Example: 500 Oracle Parkway
• deliveryAddressLine2: string
• deliveryCityName: string
  Example: Redwood Shores
• deliveryCountryCode: string
  Example: USA
• deliveryPostalCode: string
  Example: 94065
• deliveryStateName: string
  Example: CA
• description: string
  Example: description
• emailAddress: string
  Example: [e-mail]
• fax: string
  Example: 18006330738
• guestOrg: boolean
  Example: false
• id: integer (int64)
  Example: 45
• identityInstanceId: integer (int64)
  Example: 32
• legalBusinessNum: string
  Example: 18006722531
• logo: string
  Example: http://www.oracle.com/logo.svg
• name: string
  Example: My Organization
• oracleAccountName: string
  Example: Oracle
• oracleAccountNumber: string
  Example: 18006722531
• oracleServiceEntitlementId: string
  Example: PL-3243-SDW-3241-GJH
• oracleSubscriptionId: string
  Example: GOLD-18006722531
• otherPhone: string
  Example: 18003922999
• personalOrg: boolean
  Example: true
• phone: string
  Example: 16505067000
• postalCode: string
  Example: 94065
• provisioningJobs: array provisioningJobs
  The list of background jobs run for the organization.
• roleTypes: array roleTypes
  A list of business types or roles the organization is involved.
• stateName: string
  Example: CA
• tenantOwned: boolean
  Example: false
• tradingName: string
  Example: My Org Trading Name
• webUrlAddress: string
  Example: www.oracle.com

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64",
            "example":45
        },
        "name":{
            "type":"string",
            "example":"My Organization"
        },
        "code":{
            "type":"string",
            "example":"MYORG"
        },
        "tradingName":{
            "type":"string",
            "example":"My Org Trading Name"
        },
        "countryCode":{
            "type":"string",
            "example":"USA"
        },
        "addressLine1":{
            "type":"string",
            "example":"500 Oracle Parkway"
        },
        "addressLine2":{
            "type":"string"
        },
        "cityName":{
            "type":"string",
            "example":"Redwood Shores"
        },
        "stateName":{
            "type":"string",
            "example":"CA"
        },
        "county":{
            "type":"string",
            "example":"Chester"
        },
        "postalCode":{
            "type":"string",
            "example":"94065"
        },
        "deliveryCountryCode":{
            "type":"string",
            "example":"USA"
        },
        "deliveryAddressLine1":{
            "type":"string",
            "example":"500 Oracle Parkway"
        },
        "deliveryAddressLine2":{
            "type":"string"
        },
        "deliveryCityName":{
            "type":"string",
            "example":"Redwood Shores"
        },
        "deliveryStateName":{
            "type":"string",
            "example":"CA"
        },
        "deliveryPostalCode":{
            "type":"string",
            "example":"94065"
        },
        "webUrlAddress":{
            "type":"string",
            "example":"www.oracle.com"
        },
        "phone":{
            "type":"string",
            "example":"16505067000"
        },
        "fax":{
            "type":"string",
            "example":"18006330738"
        },
        "otherPhone":{
            "type":"string",
            "example":"18003922999"
        },
        "legalBusinessNum":{
            "type":"string",
            "example":"18006722531"
        },
        "logo":{
            "type":"string",
            "example":"http://www.oracle.com/logo.svg"
        },
        "emailAddress":{
            "type":"string",
            "example":"[e-mail]"
        },
        "oracleAccountNumber":{
            "type":"string",
            "example":"18006722531"
        },
        "oracleAccountName":{
            "type":"string",
            "example":"Oracle"
        },
        "oracleServiceEntitlementId":{
            "type":"string",
            "example":"PL-3243-SDW-3241-GJH"
        },
        "oracleSubscriptionId":{
            "type":"string",
            "example":"GOLD-18006722531"
        },
        "billThroughOracle":{
            "type":"boolean",
            "example":true
        },
        "identityInstanceId":{
            "type":"integer",
            "format":"int64",
            "example":32
        },
        "claimed":{
            "type":"boolean",
            "example":true
        },
        "tenantOwned":{
            "type":"boolean",
            "example":false
        },
        "personalOrg":{
            "type":"boolean",
            "example":true
        },
        "guestOrg":{
            "type":"boolean",
            "example":false
        },
        "roleTypes":{
            "type":"array",
            "description":"A list of business types or roles the organization is involved.",
            "items":{
                "type":"string",
                "description":"A list of business types or roles the organization is involved."
            }
        },
        "provisioningJobs":{
            "type":"array",
            "description":"The list of background jobs run for the organization.",
            "items":{
                "$ref":"#/components/schemas/ProvisioningJob"
            }
        },
        "description":{
            "type":"string",
            "example":"description"
        }
    }
}

Nested Schema : provisioningJobs

Type: array

The list of background jobs run for the organization.

Show Source

• Array of: object ProvisioningJob
  The list of background jobs run for the organization.

{
    "type":"array",
    "description":"The list of background jobs run for the organization.",
    "items":{
        "$ref":"#/components/schemas/ProvisioningJob"
    }
}

Nested Schema : roleTypes

Type: array

A list of business types or roles the organization is involved.

Show Source

• Array of: string
  A list of business types or roles the organization is involved.

{
    "type":"array",
    "description":"A list of business types or roles the organization is involved.",
    "items":{
        "type":"string",
        "description":"A list of business types or roles the organization is involved."
    }
}

Nested Schema : ProvisioningJob

Type: object

The list of background jobs run for the organization.

Show Source

• id: integer (int64)
  A system generated id for the job.

  Example: 2001
• metadata: object metadata
  Additional Properties Allowed: additionalProperties

  This attribute gives the context of the job.
• status: string
  Job status

  Example: NEW, RUNNING, FAILED
• type: string
  Job type

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Job status",
            "example":"NEW, RUNNING, FAILED"
        },
        "id":{
            "type":"integer",
            "description":"A system generated id for the job.",
            "format":"int64",
            "example":2001
        },
        "type":{
            "type":"string",
            "description":"Job type"
        },
        "metadata":{
            "type":"object",
            "additionalProperties":{
                "type":"string",
                "description":"This attribute gives the context of the job."
            },
            "description":"This attribute gives the context of the job."
        }
    },
    "description":"The list of background jobs run for the organization."
}

Nested Schema : metadata

Type: object

Additional Properties Allowed

Show Source

• string
  This attribute gives the context of the job.

{
    "type":"object",
    "additionalProperties":{
        "type":"string",
        "description":"This attribute gives the context of the job."
    },
    "description":"This attribute gives the context of the job."
}

This attribute gives the context of the job.

500 Response

An unexpected error occurred.

Back to Top