Jump to

• Request
• Response

Add a User to the Default LDAP Server

post

/api/v1/configuration/ldapConfig/defaultLdap/ldapUser

Add a user to the default OpenLDAP server and assign one or more global roles. The groups array must contain at least one supported role identifier.

Request

Supported Media Types

• application/json

Header Parameters

• Authorization(required): string
  Bearer access token. Supply as: Bearer .

Body ()

Root Schema : schema

Type: object

Show Source

• groups(required): array groups
  Minimum Number of Items: 1

  Global roles to assign to the new OpenLDAP user.
• ldapUserName(required): string
  LDAP UserName
• ldapUserPassword(required): string(password)
  LDAP User Password

{
    "type":"object",
    "required":[
        "ldapUserName",
        "ldapUserPassword",
        "groups"
    ],
    "properties":{
        "ldapUserName":{
            "type":"string",
            "description":"LDAP UserName"
        },
        "ldapUserPassword":{
            "type":"string",
            "format":"password",
            "description":"LDAP User Password"
        },
        "groups":{
            "type":"array",
            "minItems":1,
            "description":"Global roles to assign to the new OpenLDAP user.",
            "items":{
                "type":"string",
                "enum":[
                    "bpmAdmin",
                    "instanceAdmin",
                    "instanceOperator",
                    "instanceApiClient",
                    "walletSuperAdmin",
                    "walletOrgAdmin",
                    "walletOrgUser",
                    "daSuperAdmin",
                    "daTokenAdmin",
                    "daDeployer",
                    "daApprover"
                ]
            }
        }
    }
}

Nested Schema : groups

Type: array

Minimum Number of Items: 1

Global roles to assign to the new OpenLDAP user.

Show Source

• Array of: string
  Allowed Values: [ "bpmAdmin", "instanceAdmin", "instanceOperator", "instanceApiClient", "walletSuperAdmin", "walletOrgAdmin", "walletOrgUser", "daSuperAdmin", "daTokenAdmin", "daDeployer", "daApprover" ]

{
    "type":"array",
    "minItems":1,
    "description":"Global roles to assign to the new OpenLDAP user.",
    "items":{
        "type":"string",
        "enum":[
            "bpmAdmin",
            "instanceAdmin",
            "instanceOperator",
            "instanceApiClient",
            "walletSuperAdmin",
            "walletOrgAdmin",
            "walletOrgUser",
            "daSuperAdmin",
            "daTokenAdmin",
            "daDeployer",
            "daApprover"
        ]
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : MessageResponse

Type: object

Generic message response.

Show Source

• errors: array errors
• id: string
• message: string
• status: string
• warnings: array warnings

{
    "description":"Generic message response.",
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "errors":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

400 Response

Bad Request

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• errors: array errors
  list of errors
• message(required): string
  A human-readable error string.
• status(required): string
  A short error status that defines the error, meant for programmatic parsing.
• warnings: array warnings
  list of warnings

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

list of errors

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

list of warnings

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

401 Response

Unauthorized

Body ()

Root Schema : AuthError

Type: object

Authentication or authorization error returned by request filters.

Show Source

• code(required): string
  Allowed Values: [ "UNAUTHENTICATED", "FORBIDDEN", "NOT_FOUND" ]
• message(required): string

{
    "description":"Authentication or authorization error returned by request filters.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "enum":[
                "UNAUTHENTICATED",
                "FORBIDDEN",
                "NOT_FOUND"
            ]
        },
        "message":{
            "type":"string"
        }
    }
}

403 Response

Forbidden. The authenticated caller lacks a required global role, instance-access-group membership, or a valid CSRF token.

Body ()

Root Schema : AuthError

Type: object

Authentication or authorization error returned by request filters.

Show Source

• code(required): string
  Allowed Values: [ "UNAUTHENTICATED", "FORBIDDEN", "NOT_FOUND" ]
• message(required): string

{
    "description":"Authentication or authorization error returned by request filters.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "enum":[
                "UNAUTHENTICATED",
                "FORBIDDEN",
                "NOT_FOUND"
            ]
        },
        "message":{
            "type":"string"
        }
    }
}

409 Response

Operation conflict

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• errors: array errors
  list of errors
• message(required): string
  A human-readable error string.
• status(required): string
  A short error status that defines the error, meant for programmatic parsing.
• warnings: array warnings
  list of warnings

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

list of errors

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

list of warnings

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• errors: array errors
  list of errors
• message(required): string
  A human-readable error string.
• status(required): string
  A short error status that defines the error, meant for programmatic parsing.
• warnings: array warnings
  list of warnings

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

list of errors

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

list of warnings

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

Back to Top