Jump to

• Request
• Response

Create a user assignment group

post

/fscmRestApi/resources/11.13.18.05/userAssignmentGroups

Request

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• eligibleUsers: array Eligible Users
  Title: Eligible Users

  To add members to a user assignment group, a security administrator selects among users who are eligible, meaning that they're assigned roles enabling them to work with records of the object secured by the group.
• members: array Group Members
  Title: Group Members

  The security administrator may add users to a user assignment group, or remove them.
• Name(required): string
  Maximum Length: 200

  The group's name.
• RoleType(required): string
  Maximum Length: 100

  The group's authorization.
• SecurableType(required): string
  Maximum Length: 100

  The object type to be secured by the group.
• securityAssignments: array Group Security Assignments
  Title: Group Security Assignments

  A security assignment group may itself be secured. The administrator who owns the group may add other users as owners, editors, or viewers of the group.

{
    "required":[
        "Name",
        "RoleType",
        "SecurableType"
    ],
    "type":"object",
    "properties":{
        "SecurableType":{
            "maxLength":100,
            "type":"string",
            "description":"The object type to be secured by the group.",
            "nullable":false
        },
        "securityAssignments":{
            "title":"Group Security Assignments",
            "type":"array",
            "description":"A security assignment group may itself be secured. The administrator who owns the group may add other users as owners, editors, or viewers of the group.",
            "items":{
                "$ref":"#/components/schemas/userAssignmentGroups-securityAssignments-item-post-request"
            }
        },
        "RoleType":{
            "maxLength":100,
            "type":"string",
            "description":"The group's authorization.",
            "nullable":false
        },
        "eligibleUsers":{
            "title":"Eligible Users",
            "type":"array",
            "description":"To add members to a user assignment group, a security administrator selects among users who are eligible, meaning that they're assigned roles enabling them to work with records of the object secured by the group.",
            "items":{
                "$ref":"#/components/schemas/userAssignmentGroups-eligibleUsers-item-post-request"
            }
        },
        "Name":{
            "maxLength":200,
            "type":"string",
            "description":"The group's name.",
            "nullable":false
        },
        "members":{
            "title":"Group Members",
            "type":"array",
            "description":"The security administrator may add users to a user assignment group, or remove them.",
            "items":{
                "$ref":"#/components/schemas/userAssignmentGroups-members-item-post-request"
            }
        }
    }
}

Nested Schema : Eligible Users

Type: array

Title: Eligible Users

To add members to a user assignment group, a security administrator selects among users who are eligible, meaning that they're assigned roles enabling them to work with records of the object secured by the group.

Show Source

• Array of: object userAssignmentGroups-eligibleUsers-item-post-request

{
    "title":"Eligible Users",
    "type":"array",
    "description":"To add members to a user assignment group, a security administrator selects among users who are eligible, meaning that they're assigned roles enabling them to work with records of the object secured by the group.",
    "items":{
        "$ref":"#/components/schemas/userAssignmentGroups-eligibleUsers-item-post-request"
    }
}

Nested Schema : Group Members

Type: array

Title: Group Members

The security administrator may add users to a user assignment group, or remove them.

Show Source

• Array of: object schema

{
    "title":"Group Members",
    "type":"array",
    "description":"The security administrator may add users to a user assignment group, or remove them.",
    "items":{
        "$ref":"#/components/schemas/userAssignmentGroups-members-item-post-request"
    }
}

Nested Schema : Group Security Assignments

Type: array

Title: Group Security Assignments

A security assignment group may itself be secured. The administrator who owns the group may add other users as owners, editors, or viewers of the group.

Show Source

• Array of: object schema

{
    "title":"Group Security Assignments",
    "type":"array",
    "description":"A security assignment group may itself be secured. The administrator who owns the group may add other users as owners, editors, or viewers of the group.",
    "items":{
        "$ref":"#/components/schemas/userAssignmentGroups-securityAssignments-item-post-request"
    }
}

Nested Schema : userAssignmentGroups-eligibleUsers-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : schema

Type: object

Show Source

• GroupId: string
  Maximum Length: 100

  The member's group ID.
• Id: integer (int64)
  The member's ID.
• IsOrphan: integer (int32)
  Default Value: 0

  Either the member is valid or invalid.
• UserId: string
  Maximum Length: 100

  The member's GUID.

{
    "type":"object",
    "properties":{
        "Id":{
            "type":"integer",
            "description":"The member's ID.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "GRC::SEQUENCE_NAME":"GTG_SC_USER_GROUP_S"
            }
        },
        "UserId":{
            "maxLength":100,
            "type":"string",
            "description":"The member's GUID.",
            "nullable":false,
            "x-queryable":false
        },
        "IsOrphan":{
            "type":"integer",
            "description":"Either the member is valid or invalid.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-queryable":false,
            "x-hints":{
                "precision":1
            }
        },
        "GroupId":{
            "maxLength":100,
            "type":"string",
            "description":"The member's group ID.",
            "nullable":false,
            "x-hints":{
                "Property":"Value"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• AccessorId: string
  Maximum Length: 100

  The GUID of a user, or the ID of a group, granted a security assignment for the group.
• AccessorType: string
  Maximum Length: 20

  A type value, USER or GROUP, identifying whether the actor granted a security assignment is a user or a group.
• Id: integer (int64)
  The unique identifier of the security assignment.
• IsEditor: integer (int32)
  Indicates the user is assigned as an editor.
• IsOwner: integer (int32)
  Indicates the user is assigned as an owner.
• IsViewer: integer (int32)
  Indicates the user is assigned as a viewer.
• SecurableId: string
  Maximum Length: 100

  ID of the group that's being secured.

{
    "type":"object",
    "properties":{
        "IsEditor":{
            "type":"integer",
            "description":"Indicates the user is assigned as an editor.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "IsViewer":{
            "type":"integer",
            "description":"Indicates the user is assigned as a viewer.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "SecurableId":{
            "maxLength":100,
            "type":"string",
            "description":"ID of the group that's being secured.",
            "nullable":false
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the security assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "GRC::SEQUENCE_NAME":"GTG_SC_GROUP_SECURITY_S"
            }
        },
        "IsOwner":{
            "type":"integer",
            "description":"Indicates the user is assigned as an owner.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "AccessorId":{
            "maxLength":100,
            "type":"string",
            "description":"The GUID of a user, or the ID of a group, granted a security assignment for the group.",
            "nullable":false
        },
        "AccessorType":{
            "maxLength":20,
            "type":"string",
            "description":"A type value, USER or GROUP, identifying whether the actor granted a security assignment is a user or a group.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : userAssignmentGroups-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the user assignment group.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the user assignment group was created.
• eligibleUsers: array Eligible Users
  Title: Eligible Users

  To add members to a user assignment group, a security administrator selects among users who are eligible, meaning that they're assigned roles enabling them to work with records of the object secured by the group.
• GroupId: string
  Read Only: true

  Maximum Length: 100

  The ID of the user assignment group.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the user assignment group was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who updated the user assignment group most recently.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemberCount: integer
  Read Only: true

  The number of members of the user assignment group.
• members: array Group Members
  Title: Group Members

  The security administrator may add users to a user assignment group, or remove them.
• Name: string
  Maximum Length: 200

  The group's name.
• OrphanCount: integer
  Read Only: true

  The number of orphan (inactive) members of the user assignment group.
• PrivilegeCode: string
  Read Only: true

  Maximum Length: 100

  The privilege code associated to the user assignment group.
• RoleType: string
  Maximum Length: 100

  The group's authorization.
• SecurableType: string
  Maximum Length: 100

  The object type to be secured by the group.
• securityAssignments: array Group Security Assignments
  Title: Group Security Assignments

  A security assignment group may itself be secured. The administrator who owns the group may add other users as owners, editors, or viewers of the group.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who updated the user assignment group most recently.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the user assignment group was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SecurableType":{
            "maxLength":100,
            "type":"string",
            "description":"The object type to be secured by the group.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the user assignment group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "securityAssignments":{
            "title":"Group Security Assignments",
            "type":"array",
            "description":"A security assignment group may itself be secured. The administrator who owns the group may add other users as owners, editors, or viewers of the group.",
            "items":{
                "$ref":"#/components/schemas/userAssignmentGroups-securityAssignments-item-response"
            }
        },
        "RoleType":{
            "maxLength":100,
            "type":"string",
            "description":"The group's authorization.",
            "nullable":false,
            "x-queryable":true
        },
        "MemberCount":{
            "type":"integer",
            "description":"The number of members of the user assignment group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "eligibleUsers":{
            "title":"Eligible Users",
            "type":"array",
            "description":"To add members to a user assignment group, a security administrator selects among users who are eligible, meaning that they're assigned roles enabling them to work with records of the object secured by the group.",
            "items":{
                "$ref":"#/components/schemas/userAssignmentGroups-eligibleUsers-item-response"
            }
        },
        "GroupId":{
            "maxLength":100,
            "type":"string",
            "description":"The ID of the user assignment group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrphanCount":{
            "type":"integer",
            "description":"The number of orphan (inactive) members of the user assignment group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":200,
            "type":"string",
            "description":"The group's name.",
            "nullable":false,
            "x-queryable":true
        },
        "PrivilegeCode":{
            "maxLength":100,
            "type":"string",
            "description":"The privilege code associated to the user assignment group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "members":{
            "title":"Group Members",
            "type":"array",
            "description":"The security administrator may add users to a user assignment group, or remove them.",
            "items":{
                "$ref":"#/components/schemas/userAssignmentGroups-members-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the user assignment group was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Eligible Users

Type: array

Title: Eligible Users

To add members to a user assignment group, a security administrator selects among users who are eligible, meaning that they're assigned roles enabling them to work with records of the object secured by the group.

Show Source

• Array of: object userAssignmentGroups-eligibleUsers-item-response

{
    "title":"Eligible Users",
    "type":"array",
    "description":"To add members to a user assignment group, a security administrator selects among users who are eligible, meaning that they're assigned roles enabling them to work with records of the object secured by the group.",
    "items":{
        "$ref":"#/components/schemas/userAssignmentGroups-eligibleUsers-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Group Members

Type: array

Title: Group Members

The security administrator may add users to a user assignment group, or remove them.

Show Source

• Array of: object userAssignmentGroups-members-item-response

{
    "title":"Group Members",
    "type":"array",
    "description":"The security administrator may add users to a user assignment group, or remove them.",
    "items":{
        "$ref":"#/components/schemas/userAssignmentGroups-members-item-response"
    }
}

Nested Schema : Group Security Assignments

Type: array

Title: Group Security Assignments

A security assignment group may itself be secured. The administrator who owns the group may add other users as owners, editors, or viewers of the group.

Show Source

• Array of: object userAssignmentGroups-securityAssignments-item-response

{
    "title":"Group Security Assignments",
    "type":"array",
    "description":"A security assignment group may itself be secured. The administrator who owns the group may add other users as owners, editors, or viewers of the group.",
    "items":{
        "$ref":"#/components/schemas/userAssignmentGroups-securityAssignments-item-response"
    }
}

Nested Schema : userAssignmentGroups-eligibleUsers-item-response

Type: object

Show Source

• DisplayName: string
  Read Only: true

  Maximum Length: 128

  The eligible user's display name.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonId: integer (int64)
  Read Only: true

  The eligible user's person ID.
• RoleType: string
  Read Only: true

  Maximum Length: 128

  Authorization that qualifies this user to be eligible as an owner, editor, or viewer.
• SecurableType: string
  Read Only: true

  Maximum Length: 255

  Object for which this user qualifies to be eligible.
• UserGuid: string
  Read Only: true

  Maximum Length: 64

  The eligible user's GUID.

{
    "type":"object",
    "properties":{
        "DisplayName":{
            "maxLength":128,
            "type":"string",
            "description":"The eligible user's display name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecurableType":{
            "maxLength":255,
            "type":"string",
            "description":"Object for which this user qualifies to be eligible.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PersonId":{
            "type":"integer",
            "description":"The eligible user's person ID.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserGuid":{
            "maxLength":64,
            "type":"string",
            "description":"The eligible user's GUID.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleType":{
            "maxLength":128,
            "type":"string",
            "description":"Authorization that qualifies this user to be eligible as an owner, editor, or viewer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : userAssignmentGroups-members-item-response

Type: object

Show Source

• Displayname: string
  Read Only: true

  Maximum Length: 302

  The member's display name.
• GroupId: string
  Maximum Length: 100

  The member's group ID.
• Id: integer (int64)
  The member's ID.
• IsOrphan: integer (int32)
  Default Value: 0

  Either the member is valid or invalid.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonId: integer (int64)
  Read Only: true

  The member's person ID.
• UserId: string
  Maximum Length: 100

  The member's GUID.
• Username: string
  Read Only: true

  Maximum Length: 100

  The member's user name.

{
    "type":"object",
    "properties":{
        "PersonId":{
            "type":"integer",
            "description":"The member's person ID.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Username":{
            "maxLength":100,
            "type":"string",
            "description":"The member's user name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UserId":{
            "maxLength":100,
            "type":"string",
            "description":"The member's GUID.",
            "nullable":false,
            "x-queryable":false
        },
        "Displayname":{
            "maxLength":302,
            "type":"string",
            "description":"The member's display name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"integer",
            "description":"The member's ID.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "GRC::SEQUENCE_NAME":"GTG_SC_USER_GROUP_S"
            }
        },
        "IsOrphan":{
            "type":"integer",
            "description":"Either the member is valid or invalid.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-queryable":false,
            "x-hints":{
                "precision":1
            }
        },
        "GroupId":{
            "maxLength":100,
            "type":"string",
            "description":"The member's group ID.",
            "nullable":false,
            "x-hints":{
                "Property":"Value"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : userAssignmentGroups-securityAssignments-item-response

Type: object

Show Source

• AccessorDisplayName: string
  Read Only: true

  Maximum Length: 240

  The display name of a user, or the name of a group, granted a security assignment for a user assignment group.
• AccessorId: string
  Maximum Length: 100

  The GUID of a user, or the ID of a group, granted a security assignment for the group.
• AccessorType: string
  Maximum Length: 20

  A type value, USER or GROUP, identifying whether the actor granted a security assignment is a user or a group.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the security assignment.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the security assignment was created.
• Id: integer (int64)
  The unique identifier of the security assignment.
• IsEditor: integer (int32)
  Indicates the user is assigned as an editor.
• IsOwner: integer (int32)
  Indicates the user is assigned as an owner.
• IsViewer: integer (int32)
  Indicates the user is assigned as a viewer.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the security assignment was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who most recently updated the security assignment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SecurableId: string
  Maximum Length: 100

  ID of the group that's being secured.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who most recently updated the security assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the security assignment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the security assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IsEditor":{
            "type":"integer",
            "description":"Indicates the user is assigned as an editor.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "IsViewer":{
            "type":"integer",
            "description":"Indicates the user is assigned as a viewer.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SecurableId":{
            "maxLength":100,
            "type":"string",
            "description":"ID of the group that's being secured.",
            "nullable":false,
            "x-queryable":true
        },
        "AccessorId":{
            "maxLength":100,
            "type":"string",
            "description":"The GUID of a user, or the ID of a group, granted a security assignment for the group.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AccessorDisplayName":{
            "maxLength":240,
            "type":"string",
            "description":"The display name of a user, or the name of a group, granted a security assignment for a user assignment group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the security assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "GRC::SEQUENCE_NAME":"GTG_SC_GROUP_SECURITY_S"
            },
            "x-queryable":true
        },
        "IsOwner":{
            "type":"integer",
            "description":"Indicates the user is assigned as an owner.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the security assignment was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccessorType":{
            "maxLength":20,
            "type":"string",
            "description":"A type value, USER or GROUP, identifying whether the actor granted a security assignment is a user or a group.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

eligibleUsers

Operation: /fscmRestApi/resources/11.13.18.05/userAssignmentGroups/{GroupId}/child/eligibleUsers

Parameters:

• GroupId: $request.path.GroupId

To add members to a user assignment group, a security administrator selects among users who are eligible, meaning that they're assigned roles enabling them to work with records of the object secured by the group.

members

Operation: /fscmRestApi/resources/11.13.18.05/userAssignmentGroups/{GroupId}/child/members

Parameters:

• GroupId: $request.path.GroupId

The security administrator may add users to a user assignment group, or remove them.

securityAssignments

Operation: /fscmRestApi/resources/11.13.18.05/userAssignmentGroups/{GroupId}/child/securityAssignments

Parameters:

• GroupId: $request.path.GroupId

A security assignment group may itself be secured. The administrator who owns the group may add other users as owners, editors, or viewers of the group.

Back to Top