REST API for Oracle Identity Governance Self Service

  1. REST API for Oracle Identity Governance Self Service
  2. Tasks
  3. Organization

Get all the organizations.

get

/iam/governance/selfservice/api/v1/organizations

Returns the organizations assigned to the logged in user. The filter query parameter can be used to return a subset of the organizations. SCIM filter is accepted. For example The query to get all organizations whose name starts with Oracle is /organization?q=name sw Oracle. The attributes that are to be returned by the organization can also be controlled by specifying the attributes query parameter. A Comma-separated list of the attribute names is to be passed to the attribbutes query parameter. For example to get the organization name and description only the URI is "/organization?fields=name, description.

Request

Supported Media Types
  • application/json
Query Parameters
  • The attributes that are to be returned by the organization can also be controlled by specifying the attributes query parameter. A Comma-separated list of the attribute names is to be passed to the attributes query parameter. For example to get the organization name and description only the URI is "/organization?fields=name, description.
  • Filter can be applied for "entityType" for that possible value is - Role and "roleid" for that organizations is retrieved. here should not be any spaces for filter value. Sample value for filter is "entityType eq Role" or "entityType eq Role and roleid={roleId}".
Back to Top

Response

Supported Media Types
  • application/json

200 Response

Successful
Headers
Body (
  1. OrganizationResponse
)
Root Schema : OrganizationResponse
Type: object
Show Source
  • count(optional): integer
  • hasMore(optional): boolean
  • links(optional): array links
  • organizations(optional): array organizations
  • totalResult(optional): integer
Nested Schema : organizations
Type: array
Show Source
Nested Schema : LinkDataInstances
Type: object
Show Source
  • href(optional): string
  • rel(optional): string
Nested Schema : OrganizationResponseMap
Type: object
Show Source
  • fields(optional): array fields
  • id(optional): string
  • links(optional): array links
Nested Schema : fields
Type: array
Show Source
Nested Schema : Fields
Type: object
Show Source
  • name(optional): string
  • value(optional): string

401 Response

Unauthorized

404 Response

Resource not found

500 Response

Internal Server Error

Default Response

Unexpected error
Back to Top

Examples

This example retrieves all organizations.. The information shown here is against a pseudo system and serves as a prototype.

cURL Example

curl  -H "Content-Type: application/json"  -X GET  -u username:password  https://pseudo.com/iam/governance/selfservice/api/v1/organization

Example of GET Response Body

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

{
  "links": [
    {
      "rel": "self",
      "href": "http://pseudo.com/iam/governance/selfservice/api/v1/organizations"
    }
  ],
  "count": 2,
  "organization": [
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/organizations/5"
        }
      ],
      "id": 5,
      "fields": {
        "Certifier User Key": null,
        "Applicable Password Policy": 1,
        "Certifier User Login": null,
        "Organization Status": "Active",
        "Parent Organization Name": "Top",
        "Organization Name": "Org2",
        "act_updateby": 1,
        "act_key": 5,
        "Password Policy": null,
        "Organization Customer Type": "Company",
        "Password Policy Name": null,
        "parent_key": 3,
        "User Membership Rule": null,
        "act_createby": 1,
        "act_create": 1456833264000,
        "act_data_level": null,
        "act_update": 1456833264000,
        "Applicable Password Policy Name": null,
        "Enforce New Password Policy": "Yes",
        "act_disabled": null
      }
    },
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/organizations/4"
        }
      ],
      "id": 4,
      "fields": {
        "Certifier User Key": null,
        "Applicable Password Policy": 1,
        "Certifier User Login": null,
        "Organization Status": "Active",
        "Parent Organization Name": "Top",
        "Organization Name": "Org1",
        "act_updateby": 1,
        "act_key": 4,
        "Password Policy": null,
        "Organization Customer Type": "Company",
        "Password Policy Name": null,
        "parent_key": 3,
        "User Membership Rule": null,
        "act_createby": 1,
        "act_create": 1456819726000,
        "act_data_level": null,
        "act_update": 1456819726000,
        "Applicable Password Policy Name": null,
        "Enforce New Password Policy": "Yes",
        "act_disabled": null
      }
    }
  ]
}
Back to Top