JOC API

/inventory/repository/git/credentials/add

POST

Adds git credentials for the current JOC account in dependence to the JOC Security Levels.

Parameters in the POST body schema

Name	Type	Description	Example
`credentials`	required, array	Git credentials to store.	[{ "gitAccount" : "myExampleGitAccount", "username" : "sp", "email" : "sp@test.example.com", "keyfilePath" : "/example/path/to/keyfile", "gitServer" : "my-example-remote.git-host.net" }]
`gitAccount`	required, string	Account name for the access to the Git Server.	"gitAccount" : "myExampleGitAccount"
`username`	required, string	Username for the Git Account to be used fo author entries of commits.	"username" : "sp"
`email`	required, string	Email address for the Git Account to be used fo author entries of commits.	"email" : "sp@test.example.com"
`password`	required anyOf(`password`, `personalAccessToken`, `keyfilePath`), string	Password to use with the Git account for http(s) access to the Git Server.	"password" : "myExampleGitPasswd"
`personalAccessToken`	required anyOf(`password`, `personalAccessToken`, `keyfilePath`), string	Personal Access Token (PAT) to use with the Git account for http(s) access to the Git Server.	"personalAccessToken" : "ExaM29pl4evLx7ebhWzo"
`keyfilePath`	required anyOf(`password`, `personalAccessToken`, `keyfilePath`), string	Path to the keyfile to use for SSH access to the Git Server.	"keyfilePath" : "/example/path/to/keyfile"
`gitServer`	required, string	The hostname(:port) of the Git Server.	"gitServer" : "my-example-remote.git-host.net"
`auditLog`	optional, object	Object that contains `comment`, `timeSpent` and `ticketLink`.	{ "comment": "Operational requirement!", "timeSpent": 2 }
`comment`	optional, string	Field in `auditLog` to comment this action, e.g. the reason.
`timeSpent`	optional, integer	Field in `auditLog` to enter the time spent in minutes.
`ticketLink`	optional, string	Field in `auditLog` to enter a link to a corresponding ticket.

Request

Name

Description

Example

Type

Constraints

Default

Headers

X-Access-Token*

Request requires authentication!

550e8400-e29b-11d4-a716-446655440000

string

Body

application/json

model | example

{
    "title": "Filter To add Git credentials to a specific JOC account",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.publish.git.AddCredentialsFilter",
    "type": "object",
    "required": [
        "credentials"
    ],
    "properties": {
        "credentials": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.publish.git.GitCredentials",
                "type": "object",
                "anyOf": [{
                    "required": [
                        "gitAccount",
                        "username",
                        "email",
                        "password",
                        "gitServer"
                    ]
                }, {
                    "required": [
                        "gitAccount",
                        "username",
                        "email",
                        "personalAccessToken",
                        "gitServer"
                    ]
                }, {
                    "required": [
                        "gitAccount",
                        "username",
                        "email",
                        "keyfilePath",
                        "gitServer"
                    ]
                }],
                "properties": {
                    "gitAccount": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 100
                    },
                    "username": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 100
                    },
                    "email": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 100
                    },
                    "keyfilePath": {
                        "description": "path or filename of a private Key. Empty filename possible.",
                        "type": "string",
                        "maxLength": 255
                    },
                    "password": {
                        "type": "string"
                    },
                    "personalAccessToken": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 100
                    },
                    "gitServer": {
                        "type": "string",
                        "pattern": "^[^<>]*$",
                        "maxLength": 255
                    }
                }
            }
        },
        "auditLog": {
            "javaType": "com.sos.joc.model.audit.AuditParams",
            "type": "object",
            "properties": {
                "comment": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                },
                "timeSpent": {
                    "type": "integer",
                    "minimum": 0
                },
                "ticketLink": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                }
            }
        }
    }
}

{ "credentials": [{ "gitAccount": "myExampleGitAccount", "username": "sp", "email": "sp@test.example.com", "keyfilePath": "/example/path/to/keyfile", "gitServer": "my-example-remote.git-host.net" }] }

{
    "credentials": [{
        "gitAccount": "myExampleGitAccount",
        "username": "sp",
        "email": "sp@test.example.com",
        "keyfilePath": "/example/path/to/keyfile",
        "gitServer": "my-example-remote.git-host.net"
    }]
}

Responses

Code	Description	Body
200	Confirm add successfully	application/json model \| example { "title": "ok answer", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.Ok", "type": "object", "required": [ "deliveryDate", "ok" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "surveyDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "ok": { "type": "boolean" } } } { "deliveryDate": "2020-05-05T21:13:35Z", "ok": true } { "deliveryDate": "2020-05-05T21:13:35Z", "ok": true }
401	Unauthorized!	application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "Oops!", "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Oops!", "isAuthenticated": false, "isPermitted": false }
403	Forbidden! The user doesn't have sufficient permissions for 'add'	application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "You don't have sufficient permissions for ...", "role": "all", "isAuthenticated": true, "isPermitted": false } { "user": "root", "message": "You don't have sufficient permissions for ...", "role": "all", "isAuthenticated": true, "isPermitted": false }
420	'add' failed!	application/json model \| example { "title": "error object with delivery date", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.Err420", "type": "object", "required": [ "deliveryDate", "error" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "surveyDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "error": { "javaType": "com.sos.joc.model.common.Err", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "add failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "add failed!" } }
440	Login Timeout! The client's session has expired and must log in again.	application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "Session has expired. Please log in again", "role": "all", "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Session has expired. Please log in again", "role": "all", "isAuthenticated": false, "isPermitted": false }