Jump to

• Request
• Response

(Preview) Get list of credentials

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/credentials

(Preview) Returns a list of credentials.

Request

Path Parameters

• aiDataPlatformId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.

Query Parameters

• credentialType: string
  The type of the Credential

  Allowed Values: [ "SECRET_TOKEN", "VAULT_REFERENCE", "SERVICE_ACCOUNT" ]
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  A filter to return only resources that match the given display name exactly.
• displayNameContains: string
  A filter to return only resources whose displayName contains the provided value (case-insensitive).
• lifecycleState: string
  A filter to return only resources whose lifecycleState matches the provided value.
• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

  Default Value: 100
• page: string
  Minimum Length: 1

  For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
• sortBy: string
  The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.

  Default Value: timeCreated

  Allowed Values: [ "timeCreated", "name" ]
• sortOrder: string
  The sort order to use, either ascending (`ASC`) or descending (`DESC`).

  Allowed Values: [ "ASC", "DESC" ]

Header Parameters

• 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. The only valid characters for request IDs are letters, numbers, underscore, and dash.
• should-update-recent: boolean
  A flag to identify if the recent list should be updated.

  Default Value: false

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. A list of credentials is retrieved.

Headers

• opc-next-page: string
  For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : CredentialCollection

Type: object

Result set returned by listing credentials through the public API.

Show Source

• items(required): array items
  List of credential summaries.

{
    "description":"Result set returned by listing credentials through the public API.",
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of credential summaries.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CredentialSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of credential summaries.

Show Source

• Array of: object CredentialSummary
  Summary view of a credential for public API consumers.

{
    "description":"List of credential summaries.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CredentialSummary"
    }
}

Nested Schema : CredentialSummary

Type: object

Summary view of a credential for public API consumers.

Show Source

• createdBy: string
  Minimum Length: 1

  Maximum Length: 255

  The unique identifier of the user who created the credential object.
• credentialType(required): string
  Allowed Values: [ "SECRET_TOKEN", "VAULT_REFERENCE", "SERVICE_ACCOUNT" ]

  The type of credential stored. Allowed values are defined in CredentialType.
• description: string
  Minimum Length: 1

  Maximum Length: 255

  A brief summary of the credential object and its purpose.
• displayName(required): string
  Minimum Length: 1

  Maximum Length: 255

  Pattern: ^[A-Za-z][A-Za-z0-9_]{0,254}$

  A user-friendly name for the credential object. This value does not have to be unique and can be changed. Must start with a letter and contain only letters, numbers, or underscores. Avoid entering confidential information.
• key(required): string
  Minimum Length: 1

  Maximum Length: 255

  The unique identifier for the credential object.
• lifeCycleState: string
  Allowed Values: [ "ACTIVE", "CREATING", "UPDATING", "DELETING" ]

  The current state of the credential object. Allowed values are defined in CredentialLifecycleState.
• timeCreated: string(date-time)
  The date and time when the credential object was created, in RFC 3339 timestamp format.
• timeUpdated: string(date-time)
  The date and time when the credential object was most recently updated, in RFC 3339 timestamp format.
• updatedBy: string
  Minimum Length: 1

  Maximum Length: 255

  The unique identifier of the user who last updated the credential object.

{
    "description":"Summary view of a credential for public API consumers.",
    "type":"object",
    "required":[
        "key",
        "displayName",
        "credentialType"
    ],
    "properties":{
        "key":{
            "description":"The unique identifier for the credential object.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "displayName":{
            "description":"A user-friendly name for the credential object. This value does not have to be unique and can be changed. Must start with a letter and contain only letters, numbers, or underscores. Avoid entering confidential information.",
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "pattern":"^[A-Za-z][A-Za-z0-9_]{0,254}$"
        },
        "description":{
            "description":"A brief summary of the credential object and its purpose.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "credentialType":{
            "description":"The type of credential stored. Allowed values are defined in CredentialType.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/CredentialType",
            "enum":[
                "SECRET_TOKEN",
                "VAULT_REFERENCE",
                "SERVICE_ACCOUNT"
            ]
        },
        "timeCreated":{
            "description":"The date and time when the credential object was created, in RFC 3339 timestamp format.",
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "description":"The unique identifier of the user who created the credential object.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "timeUpdated":{
            "description":"The date and time when the credential object was most recently updated, in RFC 3339 timestamp format.",
            "type":"string",
            "format":"date-time"
        },
        "updatedBy":{
            "description":"The unique identifier of the user who last updated the credential object.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "lifeCycleState":{
            "description":"The current state of the credential object. Allowed values are defined in CredentialLifecycleState.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/CredentialLifecycleState",
            "enum":[
                "ACTIVE",
                "CREATING",
                "UPDATING",
                "DELETING"
            ]
        }
    }
}

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID 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 message.

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

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID 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 message.

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

404 Response

Not Found. The requested resource was not found.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID 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 message.

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

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID 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 message.

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

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID 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 message.

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

Default Response

Unknown Error. Error is not recognized by the system.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID 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 message.

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

Back to Top