Jump to

• Request
• Response

Assign Permission Profiles To User

post

/api/restapi/program/assignUser

Send a request to this endpoint to view the user's permission sets for the provided program.

Request

Header Parameters

• singleTransaction:
  Enabling this boolean flag will fail to successfully complete the request if an error occurred when validating any user permission profile sent as part of the request.
  Allowed Values: [ "true", "false" ]

  Default Value: false

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityProgramUserPermissions

Type: object

Title: ApiEntityProgramUserPermissions

Show Source

• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• profiles: array profiles
  List of user profiles.
• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityProgramUserPermissions",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "profiles":{
            "type":"array",
            "description":"List of user profiles.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProgramProfileInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : profiles

Type: array

List of user profiles.

Show Source

• Array of: object ApiEntityProgramProfileInput
  Title: ApiEntityProgramProfileInput

{
    "type":"array",
    "description":"List of user profiles.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramProfileInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityProgramProfileInput

Type: object

Title: ApiEntityProgramProfileInput

Show Source

• customLogProfileId: string
  Maximum Length: 255

  System-defined identifier of the custom log profile.
• fileProfileId: string
  Maximum Length: 255

  System-defined identifier of the document profile.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• programProfileId: string
  Maximum Length: 255

  System-defined identifier of the program profile.
• reportProfileId: string
  Maximum Length: 255

  System-defined identifier of the report profile.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• userName: string
  Maximum Length: 255

  Username of the user for permission assignment.

{
    "title":"ApiEntityProgramProfileInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "userName":{
            "maxLength":"255",
            "type":"string",
            "description":"Username of the user for permission assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fileProfileId":{
            "maxLength":"255",
            "type":"string",
            "description":"System-defined identifier of the document profile.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "reportProfileId":{
            "maxLength":"255",
            "type":"string",
            "description":"System-defined identifier of the report profile.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "customLogProfileId":{
            "maxLength":"255",
            "type":"string",
            "description":"System-defined identifier of the custom log profile.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programProfileId":{
            "maxLength":"255",
            "type":"string",
            "description":"System-defined identifier of the program profile.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Assign Program Permission Profiles to Multiple Users Using IDs Assign Program Permission Profiles to Multiple Users Using Codes

Back to Top

Response

Supported Media Types

• application/json

207 Response

The object was successfully integrated.

Body ()

Root Schema : ApiEntityProgramUserPermissionsResponse

Type: object

Title: ApiEntityProgramUserPermissionsResponse

Show Source

• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• profiles: array profiles
  Profiles response with individual message and statusCodes.
• programId: integer (int64)
  The unique identifier for the program.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityProgramUserPermissionsResponse",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "profiles":{
            "type":"array",
            "description":"Profiles response with individual message and statusCodes.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProfileResponse",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : profiles

Type: array

Profiles response with individual message and statusCodes.

Show Source

• Array of: object ApiEntityProfileResponse
  Title: ApiEntityProfileResponse

{
    "type":"array",
    "description":"Profiles response with individual message and statusCodes.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProfileResponse",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityProfileResponse

Type: object

Title: ApiEntityProfileResponse

Show Source

• message: string
  Error message or reason for operation failure is populated. The field is non-persistable and thus maximum length is not applicable.
• profileId: string
  Maximum Length: 255

  The system-defined unique identifier of an object profile.
• statusCode: integer (int32)
  The response code representing the state of the API operation.
• userName: string
  Maximum Length: 255

  Username of the user for permission assignment.

{
    "title":"ApiEntityProfileResponse",
    "type":"object",
    "properties":{
        "message":{
            "type":"string",
            "description":"Error message or reason for operation failure is populated. The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "userName":{
            "maxLength":"255",
            "type":"string",
            "description":"Username of the user for permission assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "statusCode":{
            "type":"integer",
            "description":"The response code representing the state of the API operation.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "profileId":{
            "maxLength":"255",
            "type":"string",
            "description":"The system-defined unique identifier of an object profile.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input for the Program service.

Back to Top