Share via

Web Pub Sub - Add User To Group

  • Reference
Service:
Azure Web PubSub Service
API Version:
2024-12-01

Add a user to the target group.

PUT {endpoint}/api/hubs/{hub}/users/{userId}/groups/{group}?api-version=2024-12-01

URI Parameters

Name In Required Type Description
endpoint
 path True

string (url)

HTTP or HTTPS endpoint for the Web PubSub service instance.
group
 path True

string

minLength: 1
maxLength: 1024
pattern: ^(?!\s+$).+$

Target group name, which length should be greater than 0 and less than 1025.
hub
 path True

string

pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$

Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.
userId
 path True

string

minLength: 1

Target user Id.
api-version
 query True

string

The version of the REST APIs.

Responses

Name Type Description
200 OK

OK
Other Status Codes

ErrorDetail

Error response

Headers

x-ms-error-code: string

Examples

WebPubSub_AddUserToGroup

Sample request

PUT {endpoint}/api/hubs/hub1/users/user1/groups/group1?api-version=2024-12-01

Sample response

Status code:
200

Definitions

Name Description
ErrorDetail

The error object.
InnerError

ErrorDetail

Object

The error object.

Name Type Description
code

string

One of a server-defined set of error codes.
details

ErrorDetail[]

An array of details about specific errors that led to this reported error.
inner

InnerError

message

string

A human-readable representation of the error.
target

string

The target of the error.

InnerError

Object
Name Type Description
code

string

A more specific error code than was provided by the containing error.
inner

InnerError