Jump to

• Request
• Response

Create a New Credential

post

/process/api/v1/credentials/maps/{param2}/keys/{param3}

Creates new credentials for the REST API.

Request

Path Parameters

• param2(required): string
  Name of the credential map
• param3(required): string
  Name of the credential key

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• description: string
• password: string
  required for PASSWORD type
• scope: string
  can be either GLOBAL or APPLICATION
• secret: string
  required for OAUTH or GENERIC type
• targetURL: string
• type: string
• username: string
  required for PASSWORD type

{
    "type":"object",
    "properties":{
        "username":{
            "type":"string",
            "description":"required for PASSWORD type"
        },
        "password":{
            "type":"string",
            "description":"required for PASSWORD type"
        },
        "secret":{
            "type":"string",
            "description":"required for OAUTH or GENERIC type"
        },
        "description":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "targetURL":{
            "type":"string"
        },
        "scope":{
            "type":"string",
            "description":"can be either GLOBAL or APPLICATION"
        }
    }
}

Examples

Select an example Create BASIC(password) credential with global scope Create Oauth credential with global scope Create OCI SIGNATUREPOLICY credential with global scope

Security

• Secured: http
  Type: http

Back to Top

Response

Supported Media Types

• text/plain

200 Response

Credential created successfully

Body ()

Root Schema : schema

Type: string

400 Response

Bad request

Body ()

Root Schema : Model8

Type: object

Show Source

• cause: string
• details: string
• errorCode: string
• message: string
• status: integer (int32)
• timestamp: string

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "errorCode":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        }
    }
}

Back to Top