Oracle Internet Directories

Quick Navigation

• GET OracleInternetDirectories
• GET OracleInternetDirectories/{id}
• GET Organizations/{id}/OracleInternetDirectories
• POST OracleInternetDirectories/{id}/Services/Query
• POST OracleInternetDirectories/{id}/Test

GET OracleInternetDirectories

Purpose

Returns a list of Oracle Internet Directories.

Required Permissions

Password Safe System Management (Read).

Request Body

None.

Response Body

Content-type: application/json

[{
    OrganizationID : Guid,
    OracleInternetDirectoryID : Guid,
    Name : string,
    Description : string,
},
…]

Response Codes

200 – Request successful. Oracle Internet Directories in response body.

For more information, please see Common Response Codes.

GET OracleInternetDirectories/{id}

Purpose

Returns an Oracle Internet Directory by ID.

Required Permissions

Password Safe System Management (Read).

URL Parameters

id: ID of the Oracle Internet Directory.

Request Body

None.

Response Body

Content-Type: application/json

{
    OrganizationID : Guid,
    OracleInternetDirectoryID : Guid,
    Name : string,
    Description : string,
}

Response Codes

200 – Request successful. Oracle Internet Directory in response body.

For more information, please see Common Response Codes.

GET Organizations/{id}/OracleInternetDirectories

Purpose

Returns a list of Oracle Internet Directories by organization ID.

Required Permissions

Password Safe System Management (Read).

URL Parameters

id: ID of the organization.

Request Body

None.

Response Body

Content-Type: application/json

[{
    OrganizationID : Guid,
    OracleInternetDirectoryID : Guid,
    Name : string,
    Description : string,
},
…]

Response Codes

200 – Request successful. Oracle Internet Directories in response body.

For more information, please see Common Response Codes.

POST OracleInternetDirectories/{id}/Services/Query

Purpose

Queries and returns DB Services for an Oracle Internet Directory by ID.

Required Permissions

Password Safe System Management (Read/Write).

URL Parameters

id: ID of the Oracle Internet Directory.

Request Body

None.

Response Body

Content-Type: application/json

{
    Success : bool,
    Message : string,
    Services : [{
    Name : string,
},
…]
}

Response Codes

200 - Request successful. Oracle Internet Directory query result in response body.

For more information, please see Common Response Codes.

POST OracleInternetDirectories/{id}/Test

Purpose

Tests the connection to an Oracle Internet Directory by ID.

Required Permissions

Password Safe System Management (Read/Write).

URL Parameters

id: ID of the Oracle Internet Directory.

Request Body

None.

Response Body

Content-Type: application/json

{
    Success : bool,
}

Response Codes

200 – Request successful. Oracle Internet Directory test result in response body.

For more information, please see Common Response Codes.